Metadata-Version: 2.1
Name: fastapi-crudrouter
Version: 0.3.1
Summary: A dynamic FastAPI router that automatically creates CRUD routes for your models
Home-page: https://github.com/awtkns/fastapi-crudrouter
Author: Adam Watkins
Author-email: cadamrun@gmail.com
License: MIT
Description: <p align="center">
          <img src="https://raw.githubusercontent.com/awtkns/fastapi-crudrouter/master/docs/en/docs/assets/logo.png" height="200" />
        </p>
        <p align="center">
          <em>âš¡ Create CRUD routes with lighting speed</em> âš¡</br>
          <sub>A dynamic FastAPI router that automatically creates CRUD routes for your models</sub>
        </p>
        <p align="center">
        <img alt="Tests" src="https://github.com/awtkns/fastapi-crudrouter/workflows/Python%20application/badge.svg" />
        <img alt="Docs" src="https://github.com/awtkns/fastapi-crudrouter/workflows/docs/badge.svg" />
          <a href="https://pypi.org/project/fastapi-crudrouter" target="_blank">
            <img src="https://img.shields.io/pypi/v/fastapi-crudrouter?color=%2334D058&label=pypi%20package" alt="Package version">
        </a>
        </p>
        
        ---
        
        **Documentation**: <a href="https://fastapi-crudrouter.awtkns.com" target="_blank">https://fastapi-crudrouter.awtkns.com</a>
        
        **Source Code**: <a href="https://github.com/awtkns/fastapi-crudrouter" target="_blank">https://github.com/awtkns/fastapi-crudrouter</a>
        
        ---
        Tired of rewriting the same generic CRUD routes? Need to rapidly prototype a feature for a presentation
        or a hackathon? Thankfully, [fastapi-crudrouter](https://github.com/awtkns/fastapi-crudrouter) has your back. As an 
        extension to the APIRouter included with [FastAPI](https://fastapi.tiangolo.com/), the FastAPI CRUDRouter will automatically
        generate and document your CRUD routes for you, all you have to do is pass your model and maybe your database connection.
        
        FastAPI-CRUDRouter is also **lighting fast**, well tested, and **production ready**.
        
        
        ## Installation
        ```bash
        pip install fastapi-crudrouter
        ```
        
        ## Basic Usage
        Below is a simple example of what the CRUDRouter can do. In just ten lines of code, you can generate all 
        the crud routes you need for any model.  A full list of the routes generated can be found [here](./routing).
        
        ```python
        from pydantic import BaseModel
        from fastapi import FastAPI
        from fastapi_crudrouter import MemoryCRUDRouter as CRUDRouter
        
        class Potato(BaseModel):
            id: int
            color: str
            mass: float
        
        app = FastAPI()
        app.include_router(CRUDRouter(model=Potato))
        ```
        
        ## OpenAPI Support
        By default, all routes generated by the CRUDRouter will be documented according to OpenAPI spec.
        
        Below are the default routes created by the CRUDRouter shown in the generated OpenAPI documentation.
        
        ![OpenAPI Route Overview](https://raw.githubusercontent.com/awtkns/fastapi-crudrouter/master/docs/en/docs/assets/RouteOverview.PNG)
        
        The CRUDRouter is able to dynamically generate detailed documentation based on the models given to it.
        
        ![OpenAPI Route Detail](https://raw.githubusercontent.com/awtkns/fastapi-crudrouter/master/docs/en/docs/assets/RouteDetail.PNG)
        
        ## Future Features :sunglasses:
        Features planned for future releases include:
         - Pagination support
         - MongoDB / motor support
         - Support for other backends
         - And much more
        
        Please open an issue if there is a specific feature you would like supported.
        
        
        
        
Keywords: fastapi,crud,restful,routing,generator
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.6
Description-Content-Type: text/markdown
