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.5.tar.gz (6.8 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.5-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fastbruno-0.1.5.tar.gz
  • Upload date:
  • Size: 6.8 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.5.tar.gz
Algorithm Hash digest
SHA256 27a3338fcc8a06c58cdcac9b41a7d08a6c1da645bfdf77c1c9b19f5bee7cfe64
MD5 d9a1f304a14cb3c4593163ed52b19857
BLAKE2b-256 8f0b1c8f0f503ef01e156247f3ce44319d68467b4d08d988b59f8dfeb4425f1d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fastbruno-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 9.1 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6a2dfe526c79e2f52b75be3e06543a385f54146f4c4bdb5c091e9f84d3911db8
MD5 7094d4ff30dcfacf7c87a4eccd8d6027
BLAKE2b-256 178116e189d18a8c24b075f2ca702ad0236592a60e33323af4d4cc02ea106821

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