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 --from py-openapi2md openapi2md <openapi schema json> <server url> <output directory>

---