python-MIT-repo-template/wiki/Getting-Started.md

Getting Started

Prerequisites

• Python <version>
• <other tools: e.g. Docker, make, poetry>

Installation

git clone <repo-url>
cd <project>
<install command, e.g. pip install -r requirements.txt>

Configuration

• Environment variables / config file(s) needed, and where to get their values
• Any secrets or credentials required, and how to obtain them safely (never commit them)

Running the project

<run command>

Running the tests

<test command>

Common issues

Symptom	Cause	Fix