Skip to main content

OpenAPI to Markdown generator

Project description

Environment

[!info] uv as package manager

uv venv .venv
source ./venv/bin/activate
uv sync

Run

python3 ./openapi2md/main.py openapi.json localhost:8000 target/openapi.md

Build binary

[!info] Build binary with pyinstaller

uv run pyinstaller --onefile \
--add-data "openapi2md/templates:openapi2md/templates" \
./openapi2md/main.py --distpath ./openapi2md/dist

copy to bin

  • openapi2md
cp ./openapi2md/dist/main ~/.local/bin/openapi2md

Remove build files

sudo rm -rf ./build/ && \
sudo rm -rf **/*dist/ && \
sudo rm -rf ./py_openapi.egg-info/ && \
sudo rm -rf **/*main.spec

uv build and publish

  • build
uv build
  • publish
uv publish
  • uvx run
uvx py-openapi2md

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

py_openapi2md-0.1.1.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

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

py_openapi2md-0.1.1-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: py_openapi2md-0.1.1.tar.gz
  • Upload date:
  • Size: 3.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.13

File hashes

Hashes for py_openapi2md-0.1.1.tar.gz
Algorithm Hash digest
SHA256 d44a53d9ef4913f1a2899440f4ebaf663dfdab52786b63d189f21effc3b720cf
MD5 6c6dfb8cdfce9872a224b5a197b05f52
BLAKE2b-256 9f0b440e967200f5b247b377cd8e1745bf48ef7e5aa42b7936824fd1227eaf55

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_openapi2md-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d51716461c84f363b3e101794f08e2684f0d5f4fa7ccace7033ceca199671a88
MD5 a177d4cbd85603c4ec1da9548ca5d238
BLAKE2b-256 6ed2d726b73634c5d3b9b5557f360e4cdb8a82ecd7f659eb0d5b7542e664dfed

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