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.1.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.1-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastbruno-0.1.1.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.1.tar.gz
Algorithm Hash digest
SHA256 b57591b5b57ddd0758d9baf718c575c0cd9030b7b80233f9329301103f9ea801
MD5 07b603d81cddf9498fb2d7d8e83e60fb
BLAKE2b-256 12e5dffdfe8c592b51383d0fa04d012ac7751dc8f9778572449b648fcace9a66

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fastbruno-0.1.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ed4bac6bba8fbaa2bb36c4e0787815f77655660d96b8263c6413a0a404a734be
MD5 6124c207e5e62603a5df4ef72c6a62ed
BLAKE2b-256 247cf067a9133012aefbee6fbc41d4bf6ba7d40e79aaa516113f8b484259d8a4

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