| Name | shoal JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | https://github.com/kyleking/shoal |
| Summary | Lazy, Python-first, alternative to make, just, doit, and invoke |
| upload_time | 2023-02-10 04:00:50 |
| maintainer | |
| docs_url | None |
| author | Kyle King |
| requires_python | >=3.7.12,<4.0.0 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# shoal
Python function and shell command task runner. Alternative to `make`, [`just`](https://github.com/casey/just), [`doit`](https://github.com/pydoit/doit), and [`invoke`](https://pypi.org/project/invoke). Used in [`calcipy`](https://pypi.org/project/calcipy)
## Installation
`poetry add shoal`
## Usage
There are two ways to use `shoal`, either as a way to organize a set of local tasks or to distribute with a package.
For more example code, see the [scripts] directory or the [tests].
### Local Runner
Create a `shoals.py` file with:
```py
from shoal import shoalling
shoalling()
```
Then run the file with:
```sh
poetry run python shoals.py --task-help
```
Add additional tasks or import tasks from a third party package (such as [`calcipy`](https://pypi.org/project/calcipy))
### Package
Create a `<package>/shoals.py` file with:
```py
from shoal import shoalling # noqa: F401
```
Add the file to your `pyproject.toml` scripts:
```toml
[tool.poetry.scripts]
shoal = "shoal:shoalling"
```
Then test with:
```sh
poetry run shoal --task-help
```
## Project Status
See the `Open Issues` and/or the [CODE_TAG_SUMMARY]. For release history, see the [CHANGELOG].
## Contributing
We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:
- [DEVELOPER_GUIDE]
- [STYLE_GUIDE]
## Code of Conduct
We follow the [Contributor Covenant Code of Conduct][contributor-covenant].
### Open Source Status
We try to reasonably meet most aspects of the "OpenSSF scorecard" from [Open Source Insights](https://deps.dev/pypi/shoal)
## Responsible Disclosure
If you have any security issue to report, please contact the project maintainers privately. You can reach us at [dev.act.kyle@gmail.com](mailto:dev.act.kyle@gmail.com).
## License
[LICENSE]
[changelog]: ./docs/CHANGELOG.md
[code_tag_summary]: ./docs/CODE_TAG_SUMMARY.md
[contributor-covenant]: https://www.contributor-covenant.org
[developer_guide]: ./docs/DEVELOPER_GUIDE.md
[license]: https://github.com/kyleking/shoal/LICENSE
[scripts]: https://github.com/kyleking/shoal/scripts
[style_guide]: ./docs/STYLE_GUIDE.md
[tests]: https://github.com/kyleking/shoal/tests
Raw data
{
"_id": null,
"home_page": "https://github.com/kyleking/shoal",
"name": "shoal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.12,<4.0.0",
"maintainer_email": "",
"keywords": "",
"author": "Kyle King",
"author_email": "dev.act.kyle@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/04/1b/fe70f1897ab8b130b6c0d398bb8bfc5a476c6457c1a8e9704e496dea4065/shoal-0.3.0.tar.gz",
"platform": null,
"description": "# shoal\n\nPython function and shell command task runner. Alternative to `make`, [`just`](https://github.com/casey/just), [`doit`](https://github.com/pydoit/doit), and [`invoke`](https://pypi.org/project/invoke). Used in [`calcipy`](https://pypi.org/project/calcipy)\n\n## Installation\n\n`poetry add shoal`\n\n## Usage\n\nThere are two ways to use `shoal`, either as a way to organize a set of local tasks or to distribute with a package.\n\nFor more example code, see the [scripts] directory or the [tests].\n\n### Local Runner\n\nCreate a `shoals.py` file with:\n\n```py\nfrom shoal import shoalling\n\nshoalling()\n```\n\nThen run the file with:\n\n```sh\npoetry run python shoals.py --task-help\n```\n\nAdd additional tasks or import tasks from a third party package (such as [`calcipy`](https://pypi.org/project/calcipy))\n\n### Package\n\nCreate a `<package>/shoals.py` file with:\n\n```py\nfrom shoal import shoalling # noqa: F401\n```\n\nAdd the file to your `pyproject.toml` scripts:\n\n```toml\n[tool.poetry.scripts]\nshoal = \"shoal:shoalling\"\n```\n\nThen test with:\n\n```sh\npoetry run shoal --task-help\n```\n\n## Project Status\n\nSee the `Open Issues` and/or the [CODE_TAG_SUMMARY]. For release history, see the [CHANGELOG].\n\n## Contributing\n\nWe welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:\n\n- [DEVELOPER_GUIDE]\n- [STYLE_GUIDE]\n\n## Code of Conduct\n\nWe follow the [Contributor Covenant Code of Conduct][contributor-covenant].\n\n### Open Source Status\n\nWe try to reasonably meet most aspects of the \"OpenSSF scorecard\" from [Open Source Insights](https://deps.dev/pypi/shoal)\n\n## Responsible Disclosure\n\nIf you have any security issue to report, please contact the project maintainers privately. You can reach us at [dev.act.kyle@gmail.com](mailto:dev.act.kyle@gmail.com).\n\n## License\n\n[LICENSE]\n\n[changelog]: ./docs/CHANGELOG.md\n[code_tag_summary]: ./docs/CODE_TAG_SUMMARY.md\n[contributor-covenant]: https://www.contributor-covenant.org\n[developer_guide]: ./docs/DEVELOPER_GUIDE.md\n[license]: https://github.com/kyleking/shoal/LICENSE\n[scripts]: https://github.com/kyleking/shoal/scripts\n[style_guide]: ./docs/STYLE_GUIDE.md\n[tests]: https://github.com/kyleking/shoal/tests\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Lazy, Python-first, alternative to make, just, doit, and invoke",
"version": "0.3.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0e27e49de5eed45ea522ecda65afbe98271737c062d653fb98bef0a46e4ad633",
"md5": "e728c90491fab6e3f77c5bbaa078da61",
"sha256": "c4d20575856455096d9c555d9073846f4a723171e1f1f657263ea3fb4650e45d"
},
"downloads": -1,
"filename": "shoal-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e728c90491fab6e3f77c5bbaa078da61",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.12,<4.0.0",
"size": 10577,
"upload_time": "2023-02-10T04:00:49",
"upload_time_iso_8601": "2023-02-10T04:00:49.784179Z",
"url": "https://files.pythonhosted.org/packages/0e/27/e49de5eed45ea522ecda65afbe98271737c062d653fb98bef0a46e4ad633/shoal-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "041bfe70f1897ab8b130b6c0d398bb8bfc5a476c6457c1a8e9704e496dea4065",
"md5": "8dba94ebd80548dc06e808d5327c0f94",
"sha256": "34a75d43f4d71a8b6a0f6ed816e63834ec41a65555177815cceef3c7a41f6908"
},
"downloads": -1,
"filename": "shoal-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "8dba94ebd80548dc06e808d5327c0f94",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.12,<4.0.0",
"size": 10082,
"upload_time": "2023-02-10T04:00:50",
"upload_time_iso_8601": "2023-02-10T04:00:50.946274Z",
"url": "https://files.pythonhosted.org/packages/04/1b/fe70f1897ab8b130b6c0d398bb8bfc5a476c6457c1a8e9704e496dea4065/shoal-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-10 04:00:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "kyleking",
"github_project": "shoal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "shoal"
}
