generated from Lerking/python-repo-template
38 lines
578 B
Markdown
38 lines
578 B
Markdown
# Getting Started
|
|
|
|
## Prerequisites
|
|
|
|
- Python `<version>`
|
|
- `<other tools: e.g. Docker, make, poetry>`
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
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
|
|
|
|
```bash
|
|
<run command>
|
|
```
|
|
|
|
## Running the tests
|
|
|
|
```bash
|
|
<test command>
|
|
```
|
|
|
|
## Common issues
|
|
|
|
| Symptom | Cause | Fix |
|
|
|---|---|---|
|
|
| | | |
|