pyscaffoldext-dsproject 0.1

PyScaffold extension for Data Science projects

pyscaffoldext-dsproject

PyScaffold extension tailored for Data Science projects. This extension is inspired by cookiecutter-data-science and enhanced in many ways.

Besides the typical PyScaffold layout, the extensions provides:

• data folder to keep your data,
• experiments folder for the actual scripts, e.g. train_model.py,
• notebooks for data exploration with Jupyter notebooks,
• notebooks/template.ipynb for starting with the most important imports and plugins,
• models for trained and serialized models, model predictions, or model summaries,
• references for data dictionaries, manuals, and all other explanatory materials.
• reports for generated analysis as HTML, PDF, LaTeX, etc. and a figures subdirectory for generated graphics and figures to be used in reporting,
• environment.yaml to create an conda environment with the most needed data science libraries and tools,

Check out the initial project structure under dsproject-demo.

Usage

Just install this package with pip install pyscaffoldext-dsproject and note that putup -h shows a new option --dsproject.

Note

This project has been set up using PyScaffold 3.2. For details and usage information on PyScaffold see https://pyscaffold.org/.