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.

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. More to come!

Quick Overview

pip install fastapi-gen
fastapi-gen my_app
cd my_app
make start-dev

or

pipx fastapi-gen my_app
cd my_app
make start-dev

If you've previously installed fastapi-gen globally via pip install fastapi-gen, we recommend you reinstall the package using pip install 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

pip install fastapi-gen
fastapi-gen my_app

or

pip install fastapi-gen 
fastapi-gen my_app --template hello_world

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.1.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

fastapi_gen-0.1.0-py3-none-any.whl (9.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastapi_gen-0.1.0.tar.gz
  • Upload date:
  • Size: 7.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.1.0.tar.gz
Algorithm Hash digest
SHA256 9b07ca92ab781c8d414077ac0aa4627b4713f28b400b1a8a515e13c4360381dd
MD5 2cef7eac9e0c51cc824f52a7a94c46dd
BLAKE2b-256 751dc81fadf03de0b3237f21a27a4eb8762c8751d75e5c376fd6b91c4a6528cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fastapi_gen-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.5 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c20782e74e4064a469c7694abd1bd161e66ed7277d1fcad0c893ae738af4f1d2
MD5 79f0bb0e5555c243c45f5ceee52cb531
BLAKE2b-256 0617a899c85993231fcd086a400af96cd130e0a30c3d677efe51a0ccaf4420a2

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