BigFastAPI

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

BigFastAPI Documentation: https://bigfa.st/,

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

Features

Create a new python project
Create a main.py file and set it up as described in the fastapi documentation
install the latest version of bigfastapi by running pip install bigfastapi
In your main.py, import FastAPI, CORSMiddleware and the create_database function (from bigfastapi.db.database.py). You can look into the bigfastapi main.py to see everything you should import
create a .env file and provide all the required environment variables. check check .env.sample file for a sample of what the env should contain
Make sure you have a main that calls uvicorn in the bottom of your file
You now 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"])
Run the main.py file python main.py to start up your server.
learn more about how to use bigfastapi at https://bigfa.st/

Fork and clone the bigfastapi repository.
Create a virtual environment with python3 -m venv env or python -m venv env
Activate the virtual environment using .\env\Scripts\Activate.ps1 (windows-powershell) or .\env\Scripts\activate.bat (windows-command prompt) or source /path/to/venv/bin/activate (linux/mac)
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
commands for building bigfastapi into a library: python setup.py sdist bdist_wheel
You can install your local version of the library into another project run: pip install <path to local bigfastapi>\dist\<name of whl file>
update on pypi using twine upload --repository-url https://upload.pypi.org/legacy/ dist/* (first install twine using 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.