project-name

One sentence describing what this project does and who it is for.

What it does

• Describe the main script or service
• Describe any secondary scripts or components
• Explain what problem it solves

Requirements

• Python 3.12+
• Service A (e.g. Invoice Ninja)
• Service B (e.g. Discourse)

Installation

git clone git@git.example.org:yourname/project-name.git /opt/project-name
cd /opt/project-name
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Configuration

Copy the example env file and fill in your values:

cp .env-example .env
nano .env
chmod 600 .env

See .env-example for descriptions of each variable.

⚠️ Never commit .env — it contains secrets and is excluded by .gitignore.

Usage

Run manually:

cd /opt/project-name
source venv/bin/activate
python3 your_script.py

Update from the repo:

cd /opt/project-name
git pull
# restart any services if needed

Full setup runbook

👉 Link to runbook

License

GPL-3.0-or-later