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

Uploaded Python 3

File details

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

File metadata

  • Download URL: py_openapi2md-0.1.7.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.7.tar.gz
Algorithm Hash digest
SHA256 21abe11646c2484a2dea771c25e1cd00bc57a57f1fdc7abd8cc1c5f462fa0d83
MD5 d4dafe96a0dced2b4ebaea8b37b477c8
BLAKE2b-256 a49cfc40eb14038ff33c088c1f713c9c9798a9016a3777acead9a140e7ed1dd0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_openapi2md-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 af1dbc3d73c4bbce6ddd951cd59667d1ff12db05fa03380f31fca3b88b00f839
MD5 6fc9fac975e079806067f58dc5cd822f
BLAKE2b-256 c044e8e0510edbcf94d7decaff43b081d753b12bbd7e523136e6b15fbd2e64e1

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