Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 1.46 KB

README.md

File metadata and controls

77 lines (54 loc) · 1.46 KB
Raw

[Project Title]

Getting Started

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

Running the App

  1. Clone the project

    git clone [https://github.com/YOUR-USERNAME/YOUR-REPOSITORY]

  2. 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

  3. run main.py

    python main.py

This will use the data located in data/raw and run through the full data pipeline.

Development

The goal of this project is to [short goal description].

The work is completed in stages:

  1. [stage 1]
  2. [stage 2]

Part 1: Title

The scope is to...

Part 2: Title

Here we will....

Authors

Adam Broniewski

License

This project is open source software licensed as MIT.

Acknowledgments