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

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastbruno-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 e75adac927bb23e697acbe9a3ed6340bf1a32693f3238de70571a8fcca712935
MD5 a426e007d3ecc97358a1094fb72fd566
BLAKE2b-256 6967f254d59bda51dc71b7a13989b4d47103c945e2a1451659c30836a30dd7e1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fastbruno-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 26091254e208764826cc19cf3a1aed14a9af2d1c5123a8f435809b940d69c919
MD5 9410062c9b3ec7bbc0d72044197659ab
BLAKE2b-256 80721c83fe5c02d781a94dfe5b2c118a8fc7930898655355096db74fdebba1b0

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