Skip to main content

Creates a FastAPI app that is ready to be deployed on Docker hosts like DigitalOcean / Render.com

Project description

make-fastapi-app

pip install make-fastapi-app

Running

make-fastapi-app

FastAPI app creation template

Linting

MacOS_Tests Ubuntu_Tests Win_Tests

Instructions

First off, make sure you have python installed and this package pip install make-fastapi-app, this will create a new global command make-fastapi-app that you will use in the steps below.

  • Create a new python github repo, let's call it "myapp"
  • Clone that "myapp" repo to your local computer
  • cd into "myapp`
  • Run make-fastapi-app at the project root.
    • Follow the instructions
  • Now git commit the files into the repo.

Now you should have a fully formed app that is ready to be used at Render.com or DigitalOcean, which will use the Dockerfile install. Everything should be automatic with this option.

Running locally

You can either run the app locally. See the run scripts at the project root. You'll need to install the project globally with pip install -e . or else use a virtual environment with python make_venv.py and then using . ./activate.sh and then pip install -e . and then running the run_dev.py which should launch everything. Also there is a VSCode build tool that will do this automatically. It will be something like Terminal -> Run Build Tools -> Run Local

Windows

This environment requires you to use git-bash.

Linting

Run ./lint.sh to find linting errors using pylint, flake8 and mypy.

Versions

  • 1.0.7: Upgrade setup.py -> pyproject.toml
  • 1.0.6: Command broke due to new python. I fixed it.
  • 1.0.5: Fixes adding +x to sh files
  • 1.0.4: Allows empty github url
  • 1.0.3: Adds post install instructions to the command line.
  • 1.0.2: Remove trailing .git and / for githurl repo input
  • 1.0.1: Adds +x to all shell scripts
  • 1.0.0: Initial commit

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

make_fastapi_app-1.0.7.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

make_fastapi_app-1.0.7-py2.py3-none-any.whl (6.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file make_fastapi_app-1.0.7.tar.gz.

File metadata

  • Download URL: make_fastapi_app-1.0.7.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for make_fastapi_app-1.0.7.tar.gz
Algorithm Hash digest
SHA256 f85ae37b61b1a25451c5fb951badeab29b5765a4ee48ff32521b764840f8869b
MD5 f3f579a41464df76b0cbb8d5e752226a
BLAKE2b-256 79b20b07eaa918122dc368c62966e76a95450d50d78b7574c4c92e0cd4eeddc3

See more details on using hashes here.

File details

Details for the file make_fastapi_app-1.0.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for make_fastapi_app-1.0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 70a0be2e2f6733bfbd182424fecf96d54b4e0d633724c9a8115554680cb10f97
MD5 3d2cf8d0d5fdc4e40cdee37baa1d6795
BLAKE2b-256 a49f3b21e94791fc87c9ddedf2dd9008168173bce7da4c979141e8af2e755190

See more details on using hashes here.

Supported by

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