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
Release history Release notifications | RSS feed
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.2.1.tar.gz
(5.7 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file py_openapi2md-0.2.1.tar.gz.
File metadata
- Download URL: py_openapi2md-0.2.1.tar.gz
- Upload date:
- Size: 5.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
91bc5cfba98d82c53d5d49c7e0f49115a8e173803177368ca06b1420bca8ae29
|
|
| MD5 |
74e298b1623d7b0eb97b19e7633efc6d
|
|
| BLAKE2b-256 |
490d1cad8a4ed711f571dd6b44d08b32b0ed2b731d4f4ec34d15f35b126c8084
|
File details
Details for the file py_openapi2md-0.2.1-py3-none-any.whl.
File metadata
- Download URL: py_openapi2md-0.2.1-py3-none-any.whl
- Upload date:
- Size: 7.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f562b6c652c5b1b42a01bb89d7a2c85c03a4dbc2da805de7ec202a42ec310051
|
|
| MD5 |
1ed6d4d777b216b53430abd29a0dd70f
|
|
| BLAKE2b-256 |
9404d87b3859e16aa31837fbc0bf9490c65e36c5b10a5d415d2f745b90dcbe6c
|