[](https://github.com/ploigos/ploigos-step-runner/actions?query=workflow%3A%22Publish+Release%22)
[](https://github.com/ploigos/ploigos-step-runner/actions?query=workflow%3A%22Publish+Dev%22+branch%3Amain)
<br />
[](https://github.com/ploigos/ploigos-step-runner/actions?query=workflow%3A%22Publish+GitHub+Pages%22+branch%3Amain)
<br />
[](https://codecov.io/gh/ploigos/ploigos-step-runner)
<br />
[](LICENSE)
# ploigos-step-runner
Ploigos Step Runner (PSR) implemented as a Python library.
## Documentation
- [Python Package Documentation](https://ploigos.github.io/ploigos-step-runner/)
- [Ploigos Overview](https://ploigos.github.io/ploigos-docs/)
## Install
Latest Release
```bash
pip install ploigos-step-runner
```
Latest Development Release
```bash
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple ploigos-step-runner
```
## Development
> :warning: **If you are running RHEL7 or older versions of Python**: This project will need Python 3.3 or better to run. If you are running on RHEL7, you can invoke `python3` in place of `python` in the following commands.
### Set Up Development Environment
```bash
cd ploigos-step-runner
python -m venv .venvs/psr-dev
source .venvs/psr-dev/bin/activate
python -m pip install --upgrade pip
python -m pip install -e '.[tests]'
```
### Run Tests
```bash
tox -e test
```
Or to run for just a particular implementer, and include the sections of code that you didn't cover
```bash
python3 -m pytest --cov --cov-report term-missing tests/step_implementers/package/test_maven_package.py
```
### Run linter
```bash
tox -e lint
```
### Run linter and all tests (a good idea before a commit)
```bash
tox
```
### Generate the Documentation Locally
If you are updating the python documentation and want to generate locally this is how you do it.
```bash
tox -e docs
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ploigos/ploigos-step-runner",
"name": "ploigos-step-runner",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "ploigos,psr,Step Runner,Trusted Software Supply Chain,Red Hat,Red Hat Services",
"author": "Red Hat Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/14/2c/b26a129798b994888c33c440981397c92f88eff7f95037552a6b34b0b9ff/ploigos-step-runner-1.0.0.tar.gz",
"platform": "",
"description": "[](https://github.com/ploigos/ploigos-step-runner/actions?query=workflow%3A%22Publish+Release%22)\n[](https://github.com/ploigos/ploigos-step-runner/actions?query=workflow%3A%22Publish+Dev%22+branch%3Amain)\n<br />\n[](https://github.com/ploigos/ploigos-step-runner/actions?query=workflow%3A%22Publish+GitHub+Pages%22+branch%3Amain)\n<br />\n[](https://codecov.io/gh/ploigos/ploigos-step-runner)\n<br />\n[](LICENSE)\n\n# ploigos-step-runner\nPloigos Step Runner (PSR) implemented as a Python library.\n\n## Documentation\n\n- [Python Package Documentation](https://ploigos.github.io/ploigos-step-runner/)\n- [Ploigos Overview](https://ploigos.github.io/ploigos-docs/)\n\n## Install\n\nLatest Release\n```bash\npip install ploigos-step-runner\n```\n\nLatest Development Release\n```bash\npip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple ploigos-step-runner\n```\n\n## Development\n\n> :warning: **If you are running RHEL7 or older versions of Python**: This project will need Python 3.3 or better to run. If you are running on RHEL7, you can invoke `python3` in place of `python` in the following commands.\n\n### Set Up Development Environment\n```bash\ncd ploigos-step-runner\npython -m venv .venvs/psr-dev\nsource .venvs/psr-dev/bin/activate\npython -m pip install --upgrade pip\npython -m pip install -e '.[tests]'\n```\n\n### Run Tests\n```bash\ntox -e test\n```\n\nOr to run for just a particular implementer, and include the sections of code that you didn't cover\n\n```bash\npython3 -m pytest --cov --cov-report term-missing tests/step_implementers/package/test_maven_package.py\n```\n\n### Run linter\n```bash\ntox -e lint\n```\n\n### Run linter and all tests (a good idea before a commit)\n```bash\ntox\n```\n\n### Generate the Documentation Locally\nIf you are updating the python documentation and want to generate locally this is how you do it.\n\n```bash\ntox -e docs\n```\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Ploigos Step Runner (PSR) implemented as a Python library.",
"version": "1.0.0",
"split_keywords": [
"ploigos",
"psr",
"step runner",
"trusted software supply chain",
"red hat",
"red hat services"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fa2924d08add382bdaa71469075c0e0f6c4fc1d510e57711f0a07a7b3c966f00",
"md5": "fabd57c37361caf2a3c936878ae800bf",
"sha256": "99874e9797f2248a26b1fc6924f5feaed195c5c7aa871b579ecc9aa222c74649"
},
"downloads": -1,
"filename": "ploigos_step_runner-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fabd57c37361caf2a3c936878ae800bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 189252,
"upload_time": "2021-11-17T20:32:34",
"upload_time_iso_8601": "2021-11-17T20:32:34.411302Z",
"url": "https://files.pythonhosted.org/packages/fa/29/24d08add382bdaa71469075c0e0f6c4fc1d510e57711f0a07a7b3c966f00/ploigos_step_runner-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "142cb26a129798b994888c33c440981397c92f88eff7f95037552a6b34b0b9ff",
"md5": "c78662c11433ca94778d5fa986227073",
"sha256": "6c92105bbf1f8771468347f7bc7adf62172d51ccfb54408ee2a51f92dd85a16e"
},
"downloads": -1,
"filename": "ploigos-step-runner-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "c78662c11433ca94778d5fa986227073",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 262933,
"upload_time": "2021-11-17T20:32:35",
"upload_time_iso_8601": "2021-11-17T20:32:35.811854Z",
"url": "https://files.pythonhosted.org/packages/14/2c/b26a129798b994888c33c440981397c92f88eff7f95037552a6b34b0b9ff/ploigos-step-runner-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-11-17 20:32:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ploigos",
"github_project": "ploigos-step-runner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ploigos-step-runner"
}
JSON
