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.0.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.0.tar.gz.
File metadata
- Download URL: py_openapi2md-0.2.0.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 |
2c26b604186d8408ae90467c19c2c6493ef482dee5525c87219044fd2eb0ab8b
|
|
| MD5 |
b575d70a662a2c1fc9132d2c464772d1
|
|
| BLAKE2b-256 |
8ee5d86bd71155f0251b54c98bf5e657aa952fff448054814b9a0c069e190bcb
|
File details
Details for the file py_openapi2md-0.2.0-py3-none-any.whl.
File metadata
- Download URL: py_openapi2md-0.2.0-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 |
b3233545d768d5973ea7d18dc0d3612c5d8155a335015369a4677243e937ec59
|
|
| MD5 |
e4360cfdd63523d5d022753b3e8c60c4
|
|
| BLAKE2b-256 |
67f09eb9eccd7302d974b91424dc87fafc367d1ab0f73c0ed64fbdfee8b120e1
|