Set up your project with a sane directory structure

Why setup your project with a sane directory structure

Doing so will help you quickly and easily find things. This is crucial when navigating your data project. If you don't do so, you will likely end up being utterly confused as to where things are located.

What does a sane directory look like

I am going to show you one particular example, but you can adapt it to however you like.

|- informative-project-name-here/
|- data/          # never add anything here into source control
|- notebooks/     # divide by usernames if needed
|- scripts/       # basically for automation
|- src/           # custom source code
|- importable_name/
|- __init__.py
|-...
|- tests/      # test suite