pyProject

A Skeleton structure for python projects.

Project Structure

The top level holds:

• .env: environment variables (ignored by git)
• .gitignore: excludes filetypes from upload to git
• requirements: package dependencies

The directories are:

• .venv : virtual environment (ignored by git)
• docs : documentation
• src : source code
• tests : test scripts

pyproject/
├── .venv/
├── data/                   # Data Files directory
|   ├── ...
|   └── README.md
├── docs/                   # Documentation directory
|   ├── ...
|   └── README.md
├── scripts/                # Executable Scripts directory
|   ├── ...
|   └── README.md
├── src/                    # Source Code directory
|   ├── ...
|   └── README.md
├── tests/                  # Test Suite directory
|   ├── ...
|   └── README.md
├── .env
├── .gitignore
├── CHANGELOG.md
├── requirements.txt
├── config.py
├── main.py
├── LICENSE
└── README.md

Requirements

The following libraries are required:

name	description
python-dotenv	Loads parameters from the .env file into environment variables.

License

This project uses the MIT license.