Generate 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.0.tar.gz
(1.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 documento-0.1.0.tar.gz.
File metadata
- Download URL: documento-0.1.0.tar.gz
- Upload date:
- Size: 1.8 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 |
84a838717f4b27c342113104c79b49e4995a81d9d949144ab4bf4d5e0c951dcb
|
|
| MD5 |
e283286196b03b1e0dd283a02e929e6d
|
|
| BLAKE2b-256 |
6e5ca7bccc41c21e454f1a07715b1f3e1c834b4d0e0c45759d3d351ad42bb466
|
File details
Details for the file documento-0.1.0-py3-none-any.whl.
File metadata
- Download URL: documento-0.1.0-py3-none-any.whl
- Upload date:
- Size: 3.0 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 |
5626b15ec65e40d98420e3baa6aaf25e43c311186e72e56d73e99661cdc16550
|
|
| MD5 |
e4590d9020a4ad17a4bca1bee84f50dc
|
|
| BLAKE2b-256 |
319da084fc84191c058c97a3b751eb7e6c51cc939938d773e2ee13c3803621bc
|
