Display documentation for backo
Project description
Documento
Display an OpenAPI documentation from a backend powered by backo.
Documento can be powered by either Swagger UI, Scalar, ReDoc or RapiDoc.
Installation
pip install documento
Usage
usage: documento [-h] [--theme {redoc,scalar,swagger,rapidoc}] [--host HOST] [--port PORT] url
Documento: OpenAPI documentation server for backo.
positional arguments:
url Base URL of the backo instance.
options:
-h, --help show this help message and exit
--theme {redoc,scalar,swagger,rapidoc}
theme to use for the documentation.
--host HOST host to serve the documentation on.
--port PORT port used to serve the documentation.
Minimal example:
In backo/example run the nationality/backoffice.py, then
documento http://localhost:5000/nationality
And access it on http://localhost:8000/.
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
documento-0.1.1.tar.gz
(3.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 documento-0.1.1.tar.gz.
File metadata
- Download URL: documento-0.1.1.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
027923be4d9d8582fc0c0e264b632561b31fd36a497c8c5041d4fd0e80368671
|
|
| MD5 |
f0ad7476958c462d089ede7caa476633
|
|
| BLAKE2b-256 |
c1b9e70d5c2b43d7ac7d55eed0fd32941cb967ce79d8fd58f7a75dd027c7efe4
|
File details
Details for the file documento-0.1.1-py3-none-any.whl.
File metadata
- Download URL: documento-0.1.1-py3-none-any.whl
- Upload date:
- Size: 6.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a18ec05c283d770d7064297e2512f12cb5b0d1780cf0bb2a174488710fec42ef
|
|
| MD5 |
aa2ea1257bf2bf8c7ecdf032bd81fb6e
|
|
| BLAKE2b-256 |
592ce919a944e85902c7bc6bdf3acc97153118a13f1fe9ae6a654564d18b2aa8
|
