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.1.5.tar.gz
(4.8 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.1.5.tar.gz.
File metadata
- Download URL: py_openapi2md-0.1.5.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3ca5933b9ffa1f54ac3c1754bad5f6d679e6d5434da4ef00f5d40e207a6bb1cf
|
|
| MD5 |
962ba48b29b3544695234518dfcfe9a0
|
|
| BLAKE2b-256 |
ab2f312daae04d808957249e43d68b8e771fd826798bcc38346a4274f781aa3e
|
File details
Details for the file py_openapi2md-0.1.5-py3-none-any.whl.
File metadata
- Download URL: py_openapi2md-0.1.5-py3-none-any.whl
- Upload date:
- Size: 6.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9dc29b73e8cac21deaad1c6f21674dd92d9058c1ca15144c196b3e01f49c9f5a
|
|
| MD5 |
82acf2cf8a15b2e8b40a81faefbc29e5
|
|
| BLAKE2b-256 |
6a0d66a823f2421c69f636c0c6b2555977087be0c417004b1b3d266d915def5a
|