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

Uploaded Python 3

File details

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

File metadata

  • Download URL: py_openapi2md-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 d226dd7c28467e6e039b3c994d0b27a2452f5717e87595ced5930d9783cfb137
MD5 da6d8b5b63dcba7e70026d96351665e9
BLAKE2b-256 9cf65f2afedc0dae2ec8ecd627fa5a40cc4d6a583797696167562a59d37171b1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for py_openapi2md-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b266bd7f7239ad61d14a4af7b6644931fb56a2eb884e06b30885536b04b39fe0
MD5 1095502a9e88da9d74b611c1601fb75f
BLAKE2b-256 3409c5d858272d65d109d71e9d189a7c6ec364b0e0098045514b5745ca6e3eea

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