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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for py_openapi2md-0.1.6.tar.gz
Algorithm Hash digest
SHA256 0ec8445cd446d125dd51a770e8fd9586d1817450948a7b495f80ecff660cf56e
MD5 46cbaf8f10d159fa3ab5bc47555f5168
BLAKE2b-256 33a5810cf1e6261500777bf350f6aca73e67fb3235e987843b5746cf306207e6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_openapi2md-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a577a4f569b9182a65ab21586bb510450917fa2ce1ceb4fdd5a5cfbcd9a639ce
MD5 f1ce8866732ddf4c81fba0137e84787b
BLAKE2b-256 915fa5bbf2ffc41a5b4585e47c78d6bd7d73ad6006d71d7fb9cd8fa7790a53b1

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