Set up a modern REST API by running one command.
Project description
FastApi Gen
Create LLM-enabled FastAPI applications without build configuration.
FastApi Gen works on macOS and Linux.
If something doesn’t work, please file an issue.
Quick Overview
pip3 install fastapi-gen
fastapi-gen my_app
cd my_app
make start-dev
or
pipx run fastapi-gen my_app
cd my_app
make start-dev
If you've previously installed fastapi-gen
globally via pip3 install fastapi-gen
, we recommend you reinstall the package using pip3 install --upgrade --force-reinstall fastapi-gen
or pipx upgrade fastapi-gen
to ensure that you use the latest version.
Then open http://localhost:8000/docs to see your app OpenAPI documentation.
Available templates:
- Default - basic template with GET/POST examples.
- NLP - natural language processing template with examples how to use local Hugginface models for summarization, named-entity recognition and text generation using LLM.
- Langchain - template with examples how to use LangChain with local Hugginface models (LLMs) for text generation and question answering.
- Llama - template with examples how to use llama.cpp and llama-cpp-python with local Llama 2 for question asnwering.
Important notes:
- Langchain template requires hardware to run and will automatically download required models, be patient.
- Llama template will download around 4GB model from Hugginface and >4GB of RAM.
Each template includes not only code, but also tests.
Get Started Immediately
You don’t need to install or configure depencendeices like FastApi or Pytest.
They are preconfigured and hidden so that you can focus on the code.
Create a project, and you’re good to go.
Creating an App
You’ll need to have Python 3.7+ or later version on your local development machine. We recommend using the latest LTS version. You can use pyenv (macOS/Linux) to switch Python versions between different projects.
Basic template
pip3 install fastapi-gen
fastapi-gen my_app
or
pip3 install fastapi-gen
fastapi-gen my_app --template hello_world
NLP template
pip install fastapi-gen
fastapi-gen my_app --template nlp
Langchain template
pip install fastapi-gen
fastapi-gen my_app --template Langchain
Llama template
pip install fastapi-gen
fastapi-gen my_app --template llama
Inside the newly created project, you can run some built-in commands:
make start
Runs the app in development mode.
Open http://localhost:8000/docs to view OpenAPI documentation in the browser.
The page will automatically reload if you make changes to the code.
make test
Runs tests.
By default, runs tests related to files changed since the last commit.
License
fastapi-gen
is distributed under the terms of the MIT license.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fastapi_gen-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 904b1c0a2e124d5cef240553f25c8cb9da86c555fea1b3f0c7ba5bb9edb0c918 |
|
MD5 | 398d342e5adba26eb16d21f2faa65b3e |
|
BLAKE2b-256 | eb6cbb49d0865f43f2f1daca002332a891d5b54dbdaf8fe3e38f435a784ea69f |