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 files for documento 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| documento-0.1.2.tar.gz | 3.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| documento-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.6 kB
Release files / documento-0.1.2.tar.gz
| Download URL | documento-0.1.2.tar.gz |
|---|---|
| Size | 3.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f71c6cc29786aed9065d61e5c0a8685d36eceed74ef4da501fcdb510b36d930a
|
|
BLAKE2b-256 checksum How to use checksums |
457d7848fca1760f01d0bff624fada2e0f9e56eacac9025920e1017a33124288
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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}
|
Release files / documento-0.1.2-py3-none-any.whl
| Download URL | documento-0.1.2-py3-none-any.whl |
|---|---|
| Size | 6.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
997ad9fcf9736cf30338eeb93472331adcafe2b455e4e4d7d8fc719ddca67f35
|
|
BLAKE2b-256 checksum How to use checksums |
a51cc4aba669282fbed49447d5cfeea38a963dbd7716e9a8d674fb4b08f9388f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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}
|