BigFastAPI

BigFastAPI is an extension of FastAPI that adds a bunch of things that are commonly used in APIs.

BigFastAPI Documentation: https://bigfastapi.com/docs/

FastAPI Documentation: https://fastapi.tiangolo.com

Features

Create a new python project
Create a main.py file
Create the requirements.txt and copy the content from here. Install all requirements
Make a folder called db and copy the database.py file from here
In your main.py, import FastAPI and the create_database function (in database.py). Import CORSMiddleware too. You can look in the main.py here to see everything you should import
Copy the env file sample from here into your new project
Clone the BigFastAPI repo. Cut out the BigFastAPI folder (the one with users.py only) and paste in your new project
Make sure you have a main that calls uvicorn in the bottom of your file
Run the main.py file. You now have a project where you can add all your endpoints. You also have access to all the functions in bigfastapi. You can include any of them by importing (from bigfastapi.countries import app as countries) and then including a router app.include_router(countries, tags=["Countries"])

Create a virtual environment with python3 -m venv env
Activate the virtual environment using .\env\bin\Activate.ps1 (windows) or source /path/to/venv/bin/activate (linux/mac)
Pull the latest commits from origin.
run pip install -r requirements.txt
Create a .env file by copying the .env.sample file
Run python main.py. Check the code to understand how to use the library
Build the library using python setup.py sdist bdist_wheel
Install the library using pip install \dist\
twine upload dist/* (install pip install twine)

When you run the sample code, visit http://127.0.0.1:7001/docs to view the documentation for all endpoints

This project is licensed under the terms of the MIT license.