Awesome
BlackSheep-API Cookiecutter template
Cookiecutter template to boostrap a new BlackSheep v2 application to build a Web API.
Getting started
pip install blacksheep-cli
blacksheep create --template api
๐ Project name example
๐ค Use controllers? Yes
๐ Use OpenAPI Documentation? Yes
๐ง Library to read settings essentials-configuration
๐ฉ App settings format (Use arrow keys)
ยป YAML
TOML
JSON
INI
Documentation
The documentation of the framework can be read here.
Features
- Basic folder structure
- Settings handled using Pydantic Settings Management or essentials-configuration
- Strategy to read configuration from YAML, TOML, JSON, INI files, and
environmental variables, or settings stored in a user's folder when using
essentials-configuration
- Handling of dependency injection, using
rodi
- Configuration of exceptions handlers
- Strategy to handle authentication and authorization, using
guardpost
For more information on rodi
For more information and documentation about rodi
, see:
Using Cookiecutter
The template can also be used with Cookiecutter
.
pip install cookiecutter
cookiecutter https://github.com/Neoteroi/BlackSheep-API