README.md

BlackSheep-MVC 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 mvc

🚀 Project name example
📜 Use OpenAPI Documentation? Yes
🔧 Library to read settings Pydantic

Documentation

The documentation of the framework can be read here.

Features

• Basic folder structure
• Settings handled using Pydantic Settings Management or essentials-configuration to read combined with Pydantic for validation
• Strategy to read configuration from YAML, TOML, JSON, INI files, and environmental variables, or settings stored in a user's folder 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-MVC

Docker image

The project template includes a Dockerfile.

To test using the image from Docker Hub:

docker run --name mvcdemo --rm -p 8080:80 \
    -e BG_COLOR='#fd7e14' \
    -e APP_ROUTE_PREFIX='orange' \
    robertoprevato/mvcdemo