Metadata-Version: 2.4
Name: binnev-python-template
Version: 7.0.4
Summary: Add your description here
Author-email: Robin Neville <robin.m.neville@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/binnev/python-template
Requires-Python: >=3.13
Description-Content-Type: text/markdown
Provides-Extra: cli
Requires-Dist: typer>=0.27.3; extra == "cli"
Provides-Extra: api
Requires-Dist: fastapi[standard]>=0.162.0; extra == "api"

# Python project template 
This project is a template for new python projects. It contains up-to-date tooling for tests, docs, versioning, and dependency management. 

In a nutshell, the idea is that you clone/fork this project, and then modify it to suit your new project. The [Getting Started](https://binnev.github.io/python-template/latest/tutorials/getting-started/) page provides a step-by-step guide. 

## Documentation
To view the documentation, run: 
```sh
mkdocs serve
```
and go to [localhost:8000](http://localhost:8000) in your browser.

The documentation provides a detailed guide to the project. It is structured using the [Diátaxis framework](https://diataxis.fr/) to help you navigate and understand the project effectively. This framework consists of 4 categories:

1. **Tutorials**: Guides that teach a concept.
2. **How-To Guides**: Step-by-step instructions to achieve specific goals or tasks.
3. **Reference**: Technical descriptions of the project's components and APIs.
4. **Explanations**: In-depth discussions of concepts and motivations. 

