| Name | jpipe-runner JSON |
| Version |
3.0.0
JSON |
| download |
| home_page | None |
| Summary | A Justification Runner designed for jPipe. |
| upload_time | 2025-08-11 13:32:02 |
| maintainer | None |
| docs_url | None |
| author | Jason Lyu |
| requires_python | >=3.11 |
| license | MIT |
| keywords |
justification
pipeline
ml
ai
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jPipe Runner
```text
_ ____ _ ____
(_) _ \(_)_ __ ___ | _ \ _ _ _ __ _ __ ___ _ __
| | |_) | | '_ \ / _ \ | |_) | | | | '_ \| '_ \ / _ \ '__|
| | __/| | |_) | __/ | _ <| |_| | | | | | | | __/ |
_/ |_| |_| .__/ \___| |_| \_\\__,_|_| |_|_| |_|\___|_|
|__/ |_|
```
A Justification Runner designed for jPipe.
## 🚀 Usage
### CLI
```bash
poetry run jpipe-runner [-h] [--variable NAME:VALUE] [--library LIB] \
[--diagram PATTERN] [--output FILE] [--dry-run] \
[--verbose] [--config-file PATH] [--gui] jd_file
```
**Key options:**
* `--variable`, `-v`: Define `NAME:VALUE` pairs for template variables.
* `--library`, `-l`: Load additional Python modules (steps).
* `--diagram`, `-d`: Select diagrams by wildcard pattern.
* `--output`, `-o`: Specify output image file (format inferred by extension).
* `--dry-run`: Validate workflow without executing.
* `--verbose`, `-V`: Enable debug logging.
* `--config-file`: Load workflow config from a YAML file.
* `--gui`: Launch the Tkinter-based `GraphWorkflowVisualizer`
Example:
```bash
poetry run jpipe-runner --variable X:10 --diagram "flow*" \
--output diagram.png workflow.jd
```
For detailed instructions on how to execute the project, including descriptions of all CLI parameters and usage examples, see the [Usage Guide](docs/USAGE.md).
## ⚙️Installation
### Prerequisites
* Python 3.10+
* [Poetry](https://python-poetry.org)
* [Graphviz](https://graphviz.org/) (`libgraphviz-dev`, `pkg-config`)
* Optional for GUI version: [Tkinter](https://docs.python.org/3/library/tkinter.html)
### From Source
```bash
# Lock and install dependencies
poetry lock
poetry install
```
### Build Package
```bash
# Run tests
poetry run pytest
# Build distributable
poetry build
```
## đź“š Learn More
* [Usage Guide](docs/USAGE.md)
* [Packaging & CI/CD](docs/PACKAGING_RELEASE.md)
* [Troubleshooting](docs/TROUBLESHOOTING.md)
* [Developer Docs (Sphinx)](docs/BUILD_DOCS.md)
* [Contributing](docs/CONTRIBUTING.md)
## đź“„ License
MIT License — see [LICENSE](LICENSE).
## 👤 Authors
* [Jason Lyu](https://github.com/xjasonlyu)
* [Baptiste Lacroix](https://github.com/BaptisteLacroix)
* [SĂ©bastien Mosser](https://github.com/mosser)
## How to cite?
```bibtex
@software{mcscert:jpipe-runner,
author = {Mosser, SĂ©bastien and Lyu, Jason and Lacroix, Baptiste},
license = {MIT},
title = {{jPipe Runner}},
url = {https://github.com/ace-design/jpipe-runner}
}
```
## Contact Us
If you're interested in contributing to the research effort related to jPipe projects, feel free to contact the PI:
- [Dr. SĂ©bastien Mosser](mailto:mossers@mcmaster.ca)
Raw data
{
"_id": null,
"home_page": null,
"name": "jpipe-runner",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "justification, pipeline, ML, AI",
"author": "Jason Lyu",
"author_email": "xjasonlyu@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c8/25/267e05879c6038754cf466776a1953dabb8895ba4360dc9aba0a6a61a851/jpipe_runner-3.0.0.tar.gz",
"platform": null,
"description": "# jPipe Runner\n\n```text\n _ ____ _ ____ \n (_) _ \\(_)_ __ ___ | _ \\ _ _ _ __ _ __ ___ _ __ \n | | |_) | | '_ \\ / _ \\ | |_) | | | | '_ \\| '_ \\ / _ \\ '__|\n | | __/| | |_) | __/ | _ <| |_| | | | | | | | __/ | \n _/ |_| |_| .__/ \\___| |_| \\_\\\\__,_|_| |_|_| |_|\\___|_| \n |__/ |_| \n```\n\nA Justification Runner designed for jPipe.\n\n## \ud83d\ude80 Usage\n\n### CLI\n\n```bash\npoetry run jpipe-runner [-h] [--variable NAME:VALUE] [--library LIB] \\\n [--diagram PATTERN] [--output FILE] [--dry-run] \\\n [--verbose] [--config-file PATH] [--gui] jd_file\n```\n\n**Key options:**\n\n* `--variable`, `-v`: Define `NAME:VALUE` pairs for template variables.\n* `--library`, `-l`: Load additional Python modules (steps).\n* `--diagram`, `-d`: Select diagrams by wildcard pattern.\n* `--output`, `-o`: Specify output image file (format inferred by extension).\n* `--dry-run`: Validate workflow without executing.\n* `--verbose`, `-V`: Enable debug logging.\n* `--config-file`: Load workflow config from a YAML file.\n* `--gui`: Launch the Tkinter-based `GraphWorkflowVisualizer`\n\nExample:\n\n```bash\npoetry run jpipe-runner --variable X:10 --diagram \"flow*\" \\\n --output diagram.png workflow.jd\n```\n\nFor detailed instructions on how to execute the project, including descriptions of all CLI parameters and usage examples, see the [Usage Guide](docs/USAGE.md).\n\n## \u2699\ufe0fInstallation\n\n### Prerequisites\n\n* Python 3.10+\n* [Poetry](https://python-poetry.org)\n* [Graphviz](https://graphviz.org/) (`libgraphviz-dev`, `pkg-config`)\n* Optional for GUI version: [Tkinter](https://docs.python.org/3/library/tkinter.html)\n\n### From Source\n\n```bash\n# Lock and install dependencies\npoetry lock\npoetry install\n```\n\n### Build Package\n\n```bash\n# Run tests\npoetry run pytest\n\n# Build distributable\npoetry build\n```\n\n## \ud83d\udcda Learn More\n\n* [Usage Guide](docs/USAGE.md)\n* [Packaging & CI/CD](docs/PACKAGING_RELEASE.md)\n* [Troubleshooting](docs/TROUBLESHOOTING.md)\n* [Developer Docs (Sphinx)](docs/BUILD_DOCS.md)\n* [Contributing](docs/CONTRIBUTING.md)\n\n## \ud83d\udcc4 License\n\nMIT License \u2014 see [LICENSE](LICENSE).\n\n## \ud83d\udc64 Authors\n\n* [Jason Lyu](https://github.com/xjasonlyu)\n* [Baptiste Lacroix](https://github.com/BaptisteLacroix)\n* [S\u00e9bastien Mosser](https://github.com/mosser)\n\n## How to cite?\n\n```bibtex\n@software{mcscert:jpipe-runner,\n author = {Mosser, S\u00e9bastien and Lyu, Jason and Lacroix, Baptiste},\n license = {MIT},\n title = {{jPipe Runner}},\n url = {https://github.com/ace-design/jpipe-runner}\n}\n```\n\n## Contact Us\n\nIf you're interested in contributing to the research effort related to jPipe projects, feel free to contact the PI:\n\n- [Dr. S\u00e9bastien Mosser](mailto:mossers@mcmaster.ca)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Justification Runner designed for jPipe.",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://github.com/jpipe-mcscert/jpipe-runner"
},
"split_keywords": [
"justification",
" pipeline",
" ml",
" ai"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0ed8e06f18d39668346c446552b14c4f3042f05b2ea76b09d52b910b851d72d5",
"md5": "5da968cd524110a3647fb2902190c5d8",
"sha256": "991d191022da5824199e545e1532d54c9d605217de5014b81de6a8337e75e560"
},
"downloads": -1,
"filename": "jpipe_runner-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5da968cd524110a3647fb2902190c5d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 36065,
"upload_time": "2025-08-11T13:32:01",
"upload_time_iso_8601": "2025-08-11T13:32:01.630867Z",
"url": "https://files.pythonhosted.org/packages/0e/d8/e06f18d39668346c446552b14c4f3042f05b2ea76b09d52b910b851d72d5/jpipe_runner-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "c825267e05879c6038754cf466776a1953dabb8895ba4360dc9aba0a6a61a851",
"md5": "48a1d98f3c7eda482b97c331d4c08c57",
"sha256": "109ed80e1aa937c53ec812e57e12c97eab9420cf15405e3e49433fbd90df9e39"
},
"downloads": -1,
"filename": "jpipe_runner-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "48a1d98f3c7eda482b97c331d4c08c57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 30953,
"upload_time": "2025-08-11T13:32:02",
"upload_time_iso_8601": "2025-08-11T13:32:02.998712Z",
"url": "https://files.pythonhosted.org/packages/c8/25/267e05879c6038754cf466776a1953dabb8895ba4360dc9aba0a6a61a851/jpipe_runner-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 13:32:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jpipe-mcscert",
"github_project": "jpipe-runner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jpipe-runner"
}
