ddoc

ddoc is a python module for generating data documentation in Excel and Word format.

Installation

This package is currently not available on PyPI.

To install it you can clone before the git repository and install with pip :

pip install ddoc/

Quick start

Bash

# for excel documentation 
make excel data_location='your_file.csv'
# for word documentation
make word data_location='your_file.csv'

Python

from ddoc import generate, generate_excel

generate('your_file.csv', out_directory='', metadata_directory='')
generate_excel('', out_directory='', metadata_directory='')

How to contribute

ddoc has been developed during my last experience. Your help is very valuable to make it better for everyone.

Check out call for contributions to see what can be improved, or open an issue if you want something.

• Contribute to the tests to make it more reliable.
• Contribute to the doc to make it clearer for everyone.
• Contribute to the examples and notebooks to share your experience with other users.
• Open issue if you met problems during development.

To make easier the contribution feel free to use virtualenv :

# create .venv and install requirement packages
make install 
# activate .venv
. activate.sh 

For more details, please refer to CONTRIBUTING.

Maintainers

For any quesiton you can contact the team members whose is responsible for the project.

TODO

• Sphinx documentation (create gallery examples)
• Explains differents addons
• Explains how to complete metadata.json file
• Correlation matrix of continuous features (only V cramer yet)
• Tests