Skip to main content

Set up a modern REST API by running one command.

Project description

FastApi Gen

Create FastAPI apps with no build configuration.

Test Package version Supported Python versions

FastApi Gen works on macOS and Linux.
If something doesn’t work, please file an issue.

Available templates:

  1. Default - basic template with GET/POST examples.
  2. NLP - natural language processing template with examples how to use local Hugginface models for summarization, named-entity recognition and text generation using LLM.
  3. Langchain - template with examples how to use LangChain with local Hugginface models (LLMs) for text generation and question answering.

Important note - Langchain template requires hardware to run and will automatically download required models, be patient.

More to come!

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.

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

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

fastapi_gen-0.3.0.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

fastapi_gen-0.3.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_gen-0.3.0.tar.gz.

File metadata

  • Download URL: fastapi_gen-0.3.0.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for fastapi_gen-0.3.0.tar.gz
Algorithm Hash digest
SHA256 b758a658296e3f3dcd2f45aa148a6202c2be97be83360d003ca508af3b8e6bf1
MD5 e6af6354a5653a2e95161e7634fca471
BLAKE2b-256 b8bc4e418d50d85aa2612de46f3bc843431764962ad71c31c2b5089343e8c0ba

See more details on using hashes here.

File details

Details for the file fastapi_gen-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: fastapi_gen-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for fastapi_gen-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 70af2dd360042047d7b6d7f528a351a0afbf9b83e4d4b49d9dcaf74a3fcebd88
MD5 108450a7fd6578c54e0bb206ab50ba43
BLAKE2b-256 f6a9b628d7867df1cae261d35308a382ff7de8c6ec1175e4c24a5ab509e4f2ab

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page