| Name | pipen-cli-ref JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | |
| Summary | Make API reference documentation for pipen pipeline/processes |
| upload_time | 2024-02-05 22:07:06 |
| maintainer | |
| docs_url | None |
| author | pwwang |
| requires_python | >=3.9,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pipen-cli-ref
Make reference documentation for [pipen][1] pipeline/processes
## Installation
```bash
pip install pipen-cli-ref
```
## Usage
```bash
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
```
[1]: https://github.com/pwwang/pipen
Raw data
{
"_id": null,
"home_page": "",
"name": "pipen-cli-ref",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "pwwang",
"author_email": "1188067+pwwang@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/ea/fe/74bdfd2b2f9c06d213290da3577a15264262ba4fe32d93417f172a2a0cef/pipen_cli_ref-0.3.0.tar.gz",
"platform": null,
"description": "# pipen-cli-ref\nMake reference documentation for [pipen][1] pipeline/processes\n\n## Installation\n\n```bash\npip install pipen-cli-ref\n```\n\n## Usage\n\n```bash\npipen ref --help\n```\n\n```\nUsage: pipen ref [-h] -p PIPELINE -d DESTDIR [-s] [-r REPLACE_TITLES]\n [-i HIDE_SECTIONS]\n\nMake API reference documentation for pipen pipeline/processes.\n\nRequired Arguments:\n -p PIPELINE, --pipeline PIPELINE\n Specify the pipeline to generate the docs for, in the\n format of `part1:part2` where `part1` could be either:\n 1. a package name that can be imported by\n `importlib.import_module`, or\n 2. a submodule of a package, for example,\n `package.module`; or\n 3. a path to a python file, for example,\n `path/to/file.py`.\n and `part2` is the name of the pipeline class.\n When the module is loaded, the pipeline class will be\n searched in the module.\n -d DESTDIR, --destdir DESTDIR\n The destination directory to save the docs.\n\nOptions:\n -h, --help show help message and exit\n -s, --show-hidden-items\n Do not include hidden items.\n -r REPLACE_TITLES, --replace-titles REPLACE_TITLES\n Replace the title of a section, in the format of\n `old=new`. Multiple replacements can be specified.\n -i HIDE_SECTIONS, --hide-sections HIDE_SECTIONS\n Hiden some sections in docstring\n```\n\n[1]: https://github.com/pwwang/pipen\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Make API reference documentation for pipen pipeline/processes",
"version": "0.3.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "487a168e0c800ce6fb434ee4f51a0a0b1247ce390bc7e812cb37491ca3fb4ea1",
"md5": "205b28772c147d5e8be9881047d50b8f",
"sha256": "99ad841dd20d7beea2f36b98e3b31260bbd5591e1e49d75e147c6b07649ec088"
},
"downloads": -1,
"filename": "pipen_cli_ref-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "205b28772c147d5e8be9881047d50b8f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 4718,
"upload_time": "2024-02-05T22:07:04",
"upload_time_iso_8601": "2024-02-05T22:07:04.518868Z",
"url": "https://files.pythonhosted.org/packages/48/7a/168e0c800ce6fb434ee4f51a0a0b1247ce390bc7e812cb37491ca3fb4ea1/pipen_cli_ref-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eafe74bdfd2b2f9c06d213290da3577a15264262ba4fe32d93417f172a2a0cef",
"md5": "5f76c5640531b54f31076b82ff75858d",
"sha256": "5f677c2a8a87c69e07994f900da8217ec002b1090816721cb792110655de4e68"
},
"downloads": -1,
"filename": "pipen_cli_ref-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "5f76c5640531b54f31076b82ff75858d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 3604,
"upload_time": "2024-02-05T22:07:06",
"upload_time_iso_8601": "2024-02-05T22:07:06.146992Z",
"url": "https://files.pythonhosted.org/packages/ea/fe/74bdfd2b2f9c06d213290da3577a15264262ba4fe32d93417f172a2a0cef/pipen_cli_ref-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 22:07:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pipen-cli-ref"
}
