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.4.tar.gz (6.4 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.4-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastbruno-0.1.4.tar.gz
  • Upload date:
  • Size: 6.4 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.4.tar.gz
Algorithm Hash digest
SHA256 1f4a5e39be7b95e918f01bdbb5bf077e7cad970e2f603c64b5c4456ce465301c
MD5 02373408cff5a0b003505215bd086f98
BLAKE2b-256 cf7c1aced1996f408ec8f9c57b8cd525e93fc8dc5b0251d22f4e81a1aec30979

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fastbruno-0.1.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b33279a785698fbcf8edc07f05dc3a8b025c0c90f1f59a091e4ba7877775496e
MD5 3803132f4d65f8ba266e135e3ede4b08
BLAKE2b-256 79093a44c320783be998947acb04a33345900b9b2df0710dc7bdd05aaf9be3a7

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