Skip to content
/ python-base-api Public template

A python template repository for python projects that need support for an API, database and CI/CD using uv.

License

Notifications You must be signed in to change notification settings

NoxelS/python-base-api

Repository files navigation

Python Base API Boilerplate

Release Build status codecov Commit activity License

This is a template repository for Python projects that use uv for their dependency management, fastapi as API server and some CI/CD pipelines for automated testing and code coverage.

Getting started with your project

1. Using This Template

Cick on "Use this template" to create a repository based on the python base api repository.

2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

make install

This will also generate your uv.lock file.

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

uv run pre-commit run -a

Repository initiated with fpgmaas/cookiecutter-uv.

About

A python template repository for python projects that need support for an API, database and CI/CD using uv.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published