This project's working branch is main, and it has the following directory structure:
[REPOSITORY-Name]
├── LICENSE.md
├── Pipfile
├── Pipfile.lock
├── README.md
├── data
│ ├── raw
│ └── processed
├── docs
│ └── support documentation and project descriptions
└── src
└── all executbale script files
-
Clone the project
git clone [https://github.com/YOUR-USERNAME/YOUR-REPOSITORY]
-
Install dependencies from pipfile. More pipenv install info here
# install pipenv if you don't have it pip install --user pipenv# now we can install required dependencies pipenv install -
run
main.pypython main.py
This will use the data located in data/raw and run through the full data pipeline.
The goal of this project is to [short goal description].
The work is completed in stages:
- [stage 1]
- [stage 2]
The scope is to...
Here we will....
This project is open source software licensed as MIT.