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.2.tar.gz
(3.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.2.tar.gz.
File metadata
- Download URL: py_openapi2md-0.1.2.tar.gz
- Upload date:
- Size: 3.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
baaa63753c8f39e15ae44af921c5e447dec3d5ba84a6dac25780ed295c925bdc
|
|
| MD5 |
9e010f1f3ecca95291f9aae64838cfd2
|
|
| BLAKE2b-256 |
dae8cfa90d21201ef4250e8dbb240d6d12ddef70d709b0126697982ded6dcc6f
|
File details
Details for the file py_openapi2md-0.1.2-py3-none-any.whl.
File metadata
- Download URL: py_openapi2md-0.1.2-py3-none-any.whl
- Upload date:
- Size: 4.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
36a281ba3532fbb19be798881c632e9b6d59a1796652a7740222b225779a2151
|
|
| MD5 |
f5e589b705a47951f3637555ca2137d6
|
|
| BLAKE2b-256 |
b25772601798e095e1ac8d5133cfc0ccf8c33ff7ff0b9b44e4e54540e831c96e
|