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:

• dependency injection in BlackSheep
• rodi

Using Cookiecutter

The template can also be used with Cookiecutter.

pip install cookiecutter

cookiecutter https://github.com/Neoteroi/BlackSheep-API

Docker image

The project template includes a Dockerfile.

To test using the image from Docker Hub:

docker run --name apidemo --rm -p 8080:80 robertoprevato/apidemo

And navigate to:

http://localhost:8080/docs/