Giter Club home page Giter Club logo

shuttleasgi-aiapi's Introduction

ShuttleASGI Cookiecutter template

Cookiecutter template to boostrap a new ShuttleASGI application to build a Web API.

Getting started

pip install shuttleasgi-cli
shuttleasgi create --template aiapi

๐Ÿš€ 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
  • Configuration of basic OpenAI formatted exceptions handlers
  • Configuration of basic middleware(s) with OpenAI style request ID's for logging and debugging purposes
  • OpenAI formatted template routes (/v1/models, /v1/chat/completions, /v1/images/generations, etc.)
  • Template AIModel system to create, load, manage, and use various AIModels; dynamically loads to /v1/models and gets for other routes respectively.
  • 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
  • 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/herumes/ShuttleASGI-AIAPI

Credits to original BlackSheep/BlackSheep-CLI creator(s).

shuttleasgi-aiapi's People

Contributors

herumes avatar

Watchers

Kostas Georgiou avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.