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.4.tar.gz (4.9 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.4-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for py_openapi2md-0.1.4.tar.gz
Algorithm Hash digest
SHA256 45f2f3236040dc01f27f670ce9664610d2c4d26718b88a11b7fe3f68aeda8994
MD5 b4ea8f8135908c5d761794236a7bb1ad
BLAKE2b-256 e647155bf3a9556f6ec357e8fc77eb384d61a80eefcef21e90f71b05b277ae8a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_openapi2md-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f398d23f9dc6f518bb395a1430d48a02ebf32ab0a16db450e8565e52c24d9874
MD5 e161a49cd0d03b43dc78bf6c39385643
BLAKE2b-256 cd8b68dac2f3213598fa3075b6345924610ef617307a54d84875c97450834708

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