Software Development/Project Structure

From The Thinkulum
Jump to navigation Jump to search

I make a directory on my local machine named whatever I'm using for the GitHub URL (e.g., math-student-sim), and I create this structure inside it:

docs/
<package>/
tests/
app.py
LICENSE.md
MANIFEST.in
README.md
setup.py

My package name is usually the project name without the hyphens (e.g., mathstudentsim).

I'll fill in more of the details in later sections.