pipen-cli-ref
Make reference documentation for pipen pipeline/processes
Installation
pip install pipen-cli-ref
Usage
pipen ref --help
Usage: pipen ref [-h] -p PIPELINE -d DESTDIR [-s] [-r REPLACE_TITLES]
[-i HIDE_SECTIONS]
Make API reference documentation for pipen pipeline/processes.
Required Arguments:
-p PIPELINE, --pipeline PIPELINE
Specify the pipeline to generate the docs for, in the
format of `part1:part2` where `part1` could be either:
1. a package name that can be imported by
`importlib.import_module`, or
2. a submodule of a package, for example,
`package.module`; or
3. a path to a python file, for example,
`path/to/file.py`.
and `part2` is the name of the pipeline class.
When the module is loaded, the pipeline class will be
searched in the module.
-d DESTDIR, --destdir DESTDIR
The destination directory to save the docs.
Options:
-h, --help show help message and exit
-s, --show-hidden-items
Do not include hidden items.
-r REPLACE_TITLES, --replace-titles REPLACE_TITLES
Replace the title of a section, in the format of
`old=new`. Multiple replacements can be specified.
-i HIDE_SECTIONS, --hide-sections HIDE_SECTIONS
Hiden some sections in docstring
Metadata
Release files for pipen-cli-ref 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pipen_cli_ref-1.0.3.tar.gz | 131.5 kB | Without provenance | Details for pipen_cli_ref-1.0.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pipen_cli_ref-1.0.3-py3-none-any.whl | Python 3 | none | any | Details for pipen_cli_ref-1.0.3-py3-none-any.whl |
Total release size: 136.2 kB
Release files / pipen_cli_ref-1.0.3.tar.gz
| Download URL | pipen_cli_ref-1.0.3.tar.gz |
|---|---|
| Size | 131.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c516850fd4563968288b90e70be8f53b82d6601b5eaf952cf7e0673d4f1359d2
|
|
BLAKE2b-256 checksum How to use checksums |
8849c61e3c1e766ecebca3530bd95a81d6b1df4839793ec568935159ef8a4815
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","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 / pipen_cli_ref-1.0.3-py3-none-any.whl
| Download URL | pipen_cli_ref-1.0.3-py3-none-any.whl |
|---|---|
| Size | 4.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f170d1baa98f9933251467ff39492b702d509fa9a10480302f31157bcf6fb308
|
|
BLAKE2b-256 checksum How to use checksums |
2d338f670ea5c125fd23e9d00b4a748f6b25eeed2f9a453f24544a5bf2775da4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","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}
|
Security for pipen-cli-ref 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.