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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: py_openapi2md-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 eb9654c3d1a3773fac63517918a64431f296f238806dd558a48731e19e7ecf30
MD5 9f463c77d1eb12582ec7d1319c8f583a
BLAKE2b-256 f50372580fb456c01e7c23d69c5e2eff1621d9e53132b56d84e9fc32fa85d130

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_openapi2md-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ec5a536631639c803641eb3aacba60dc4beb0563236958cf2dfe9cbb9188a5b6
MD5 e3838c714c774b369e9f31ed96077a18
BLAKE2b-256 eefd567faf17db4c8729a8e40358320c983fbb69a2ac22691c5c050c4e384f13

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