Skip to main content

A FastAPI extension package to generate Bruno API documentation

Project description

Welcome to Fast Bruno

Fast Bruno is a tool that allows you to generate Bruno files from FastAPI apps. What if you could generate a bunch of Bruno files from your FastAPI app and have them automatically updated when you make changes to your app?

Fast Bruno allows you to do just that saving you a lot of time writing repetitive API routes and queries.

Install

pip install fastbruno

Usage

fastbruno is very simple to use. Just give it the path to your FastAPI app, just like you would do with uvicorn or fastapi run.

# fastbruno <path_to_your_fastapi_app>
fastbruno "app.main:app"

And Boom! This will generate a bruno directory in the root of your project containing all the Bruno files for your API routes. Now open your Bruno app and open the bruno folder and you should see all your favorite API routes and queries.

Report an issue

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

fastbruno-0.1.2.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

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

fastbruno-0.1.2-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file fastbruno-0.1.2.tar.gz.

File metadata

  • Download URL: fastbruno-0.1.2.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.6 Windows/11

File hashes

Hashes for fastbruno-0.1.2.tar.gz
Algorithm Hash digest
SHA256 01b5d1542bc3cba20b631b812ffee2e9566e51cdb5d526002ba7ff74fb3d4c4a
MD5 424a0ecd6b7ca4983e2da14f286280c2
BLAKE2b-256 201669626fef618c320e8067da796d247f1888796da68a1c2b4a2be4370527a6

See more details on using hashes here.

File details

Details for the file fastbruno-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: fastbruno-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.6 Windows/11

File hashes

Hashes for fastbruno-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 27a648a6721988f3509dbce27aac1905e17db5a4474f08fe1ccd1741bd461f12
MD5 bc98d40bb9dcb183ea7a3e058ebb32ea
BLAKE2b-256 4c9c0342237646f9f5ee105af8980c19bc6e8deeb549aace9625ab44f7c6bf40

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