An open API service indexing awesome lists of open source software.

https://github.com/laviprog/python-best-template

A clean and modern Python project template β€” ready for production, scalable, and developer-friendly.
https://github.com/laviprog/python-best-template

docker pytest python python-template uv workflow

Last synced: 5 months ago
JSON representation

A clean and modern Python project template β€” ready for production, scalable, and developer-friendly.

Awesome Lists containing this project

README

          

# 🐍 Python Best Template

A clean and modern Python project template β€” ready for production, scalable, and developer-friendly.

---

## πŸ“š Table of Contents

- [πŸ“¦ Installation](#-installation)
- [πŸ” Option 1: Use as GitHub Template (Recommended)](#-option-1-use-as-github-template-recommended)
- [🧱 Option 2: Clone Directly](#-option-2-clone-directly)
- [πŸ“ Project Structure](#-project-structure)
- [🀝 Contributing](#-contributing)
- [πŸ“„ License](#-license)

---

## πŸ“¦ Installation

### πŸ” Option 1: Use as GitHub Template (Recommended)

Click the "Use this template" button on the top right of the [repository page](https://github.com/laviprog/python-best-template) to create a new repository based on this template.

### 🧱 Option 2: Clone Directly

If you prefer to manually clone and configure the template, follow these steps:

1. Clone the template repository
```bash
git clone https://github.com/laviprog/python-best-template.git
```
2. Navigate into the project directory'
```bash
cd python-best-template
```
3. Remove the existing git history
```bash
rm -rf .git
```

You’re now ready to start building your own project using this template!

## πŸ“ Project Structure

```
python-best-template/
β”œβ”€β”€ src/ # main application code
β”‚ β”œβ”€β”€ __init__.py
β”‚ β”œβ”€β”€ config.py
β”‚ └── main.py
β”œβ”€β”€ tests/
β”œβ”€β”€ .env.example
β”œβ”€β”€ Dockerfile
β”œβ”€β”€ docker-compose.yml
β”œβ”€β”€ pytest.ini
β”œβ”€β”€ pyproject.toml
β”œβ”€β”€ requirements.txt
└── README.md
```

## 🀝 Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

## πŸ“„ License

This project is licensed under the MIT License.