# duty
[![ci](https://github.com/pawamoy/duty/workflows/ci/badge.svg)](https://github.com/pawamoy/duty/actions?query=workflow%3Aci)
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/duty/)
[![pypi version](https://img.shields.io/pypi/v/duty.svg)](https://pypi.org/project/duty/)
[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/duty)
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#duty:gitter.im)
A simple task runner.
Inspired by [Invoke](https://github.com/pyinvoke/invoke).
![demo](demo.svg)
## Installation
With `pip`:
```bash
pip install duty
```
With [`pipx`](https://github.com/pipxproject/pipx):
```bash
python3.8 -m pip install --user pipx
pipx install duty
```
## Quick start
Create a `duties.py` file at the root of your repository.
```python
from duty import duty
@duty
def docs(ctx):
ctx.run("mkdocs build", title="Building documentation")
```
You can now use the command line tool to run it:
```bash
duty docs
```
See the [Usage](https://pawamoy.github.io/duty/usage/)
section in the documentation for more examples.
Also see ["Why choosing duty over..."](https://pawamoy.github.io/duty/#why-duty-over).
Raw data
{
"_id": null,
"home_page": null,
"name": "duty",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "task-runner, task, runner, cross-platform",
"author": null,
"author_email": "=?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>",
"download_url": "https://files.pythonhosted.org/packages/da/57/2105ca4f93fc9420565c1d7f122afe83eca650d9a5db27782996d02d367a/duty-1.3.0.tar.gz",
"platform": null,
"description": "# duty\n\n[![ci](https://github.com/pawamoy/duty/workflows/ci/badge.svg)](https://github.com/pawamoy/duty/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/duty/)\n[![pypi version](https://img.shields.io/pypi/v/duty.svg)](https://pypi.org/project/duty/)\n[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/pawamoy/duty)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#duty:gitter.im)\n\nA simple task runner.\n\nInspired by [Invoke](https://github.com/pyinvoke/invoke).\n\n![demo](demo.svg)\n\n## Installation\n\nWith `pip`:\n\n```bash\npip install duty\n```\n\nWith [`pipx`](https://github.com/pipxproject/pipx):\n\n```bash\npython3.8 -m pip install --user pipx\npipx install duty\n```\n\n## Quick start\n\nCreate a `duties.py` file at the root of your repository.\n\n```python\nfrom duty import duty\n\n@duty\ndef docs(ctx):\n ctx.run(\"mkdocs build\", title=\"Building documentation\")\n```\n\nYou can now use the command line tool to run it:\n\n```bash\nduty docs\n```\n\nSee the [Usage](https://pawamoy.github.io/duty/usage/)\nsection in the documentation for more examples.\n\nAlso see [\"Why choosing duty over...\"](https://pawamoy.github.io/duty/#why-duty-over).\n",
"bugtrack_url": null,
"license": "ISC",
"summary": "A simple task runner.",
"version": "1.3.0",
"project_urls": {
"Changelog": "https://pawamoy.github.io/duty/changelog",
"Discussions": "https://github.com/pawamoy/duty/discussions",
"Documentation": "https://pawamoy.github.io/duty",
"Funding": "https://github.com/sponsors/pawamoy",
"Gitter": "https://gitter.im/duty/community",
"Homepage": "https://pawamoy.github.io/duty",
"Issues": "https://github.com/pawamoy/duty/issues",
"Repository": "https://github.com/pawamoy/duty"
},
"split_keywords": [
"task-runner",
" task",
" runner",
" cross-platform"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "942fe650b6910cf74c260903e6d29a7ec9f263531d34f2fbccc19306f8220de9",
"md5": "a78c203f79e4447815ee4eca74ced1cd",
"sha256": "4ea3d11b345170ed81e631cd65886c983f56deb4e1958ddf53678b6afeed308c"
},
"downloads": -1,
"filename": "duty-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a78c203f79e4447815ee4eca74ced1cd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 51925,
"upload_time": "2024-04-28T11:33:40",
"upload_time_iso_8601": "2024-04-28T11:33:40.486026Z",
"url": "https://files.pythonhosted.org/packages/94/2f/e650b6910cf74c260903e6d29a7ec9f263531d34f2fbccc19306f8220de9/duty-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da572105ca4f93fc9420565c1d7f122afe83eca650d9a5db27782996d02d367a",
"md5": "d7fd4c79d7e306d7f83effb3bdbc7e98",
"sha256": "103d1d014096c8d87ed4e8a1aa9608272a836769b4b248ba2cfb23e7c260fe84"
},
"downloads": -1,
"filename": "duty-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "d7fd4c79d7e306d7f83effb3bdbc7e98",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 43329,
"upload_time": "2024-04-28T11:33:42",
"upload_time_iso_8601": "2024-04-28T11:33:42.962141Z",
"url": "https://files.pythonhosted.org/packages/da/57/2105ca4f93fc9420565c1d7f122afe83eca650d9a5db27782996d02d367a/duty-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-28 11:33:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pawamoy",
"github_project": "duty",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "duty"
}