A production-ready template for Python standalone scripts and applications. This repository includes a pre-configured environment for dependency management, automated task running, and code quality tools.
├── src/ # Application source code
│ ├── __init__.py
│ └── main.py # Entry point
├── tests/ # Unit and integration tests
├── docs/ # Documentation
├── .gitignore # Standard Python/VSCode ignore rules
├── .env-example # EXample file showing required sectrets for the project. Never commit secrets to your repo!!!!
├── justfile # Command runner for common tasks
├── pyproject,toml # Project configuration file
├── requirements.txt # Pinned dependencies (auto-generated)
└── README.md # This file
## 🛠 Prerequisites
Before starting, ensure you have the following installed:
- Python
- just (command runner): brew install just
- pip-tools: pip install pip-tools
## 🚀 Getting Started
1. Initialize the Environment
Clone the template and run the setup command to create a virtual environment and install dependencies:
Bash
git clone <your-repo-url> <your-project-folder>
cd <your-project-folder>
just setup
2. Dependency Management
This project uses pip-tools to ensure reproducible environments.
- To add a new package: Add it to `requirements.in`.
- To lock versions: Run `just pin-deps`.
- To sync your environment: Run `just sync-deps`.
3. Running the Application
Bash
just run