elsdes3 / cookiecutter-portfolio

An auto-generated data analytics project template

Minimal Datascience Project Template

Table of Contents

1. About
2. Requirements
   • Operating System
   • System and Python Packages
3. Usage
4. Notes
5. Issues
6. Contributing
7. License

About

Create a minimal folder structure for a data science project.

Requirements

Operating System

The instructions in this file have only been verified on Linux and MacOS systems. At the moment, it is not known if these instructions will work on a Windows system.

System and Python Packages

1. Install the Python packages

   • cookiecutter
   • tox

   using

   pip3 install cookiecutter tox

2. Install Make (link)

3. Install git from here.

Usage

1. Clone this repo

   cd Downloads
   git clone https://github.com/elsdes3/cookiecutter-portfolio.git

2. Set your prefered values for all variables in
   • cookiecutter-portfolio/cookiecutter-project/config.yaml
3. Change into the project directory

   cd cookiecutter-portfolio

4. Create the templated project, run code formatting checks in the resulting project and run the resulting starter notebook (01_get_data.ipynb and 02_process_data.ipynb) programmatically using

   make build

Tests

1. To test that the expected template is produced

   make test clean-tests

Notes

1. Every variable present in cookiecutter.json must also be present in config.yaml. Values will only be taken from cookiecutter-portfolio/cookiecutter-project/config.yaml. Values in cookiecutter-portfolio/cookiecutter-project/cookiecutter.json will be ignored.
2. This template a customized version of the cookiecutter-datascience template (v2).
3. The Python library tox is used for managing Python virtual environments. See these links (1, 2) for details about how tox can be used to do this for a machine learning project.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Contributing

Contributions are welcome, and they are greatly appreciated! Credit will always be given.

License

Distributed under the terms of the MIT license, cookiecutter-portfolio is free and open source software.