| Name | dart-tools JSON |
| Version |
0.5.6
JSON |
| download |
| home_page | None |
| Summary | The Dart CLI and Python Library |
| upload_time | 2024-04-16 22:06:42 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Dart Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
dart
cli
projectmanagement
taskmanagement
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<div align="center">
<h1>Dart Tools</h1>
<p>
<a href="https://pypi.org/project/dart-tools"><img src="https://img.shields.io/pypi/v/dart-tools.svg" alt="PyPI"></a>
<a href="tox.ini"><img src="https://img.shields.io/pypi/pyversions/dart-tools" alt="Supported Python Versions"></a>
<a href="LICENSE"><img src="https://img.shields.io/github/license/its-dart/dart-tools" alt="License"></a>
</p>
</div>
[Dart](https://itsdart.com?nr=1) is Project Management powered by AI.
`dart-tools` is the Dart CLI and Python Library. It enables direct integration with Dart through a terminal CLI or through Python.
- [Setup](#setup)
- [Using the CLI](#using-the-cli)
- [Using the Python Library](#using-the-python-library)
- [Advanced Usage](#advanced-usage)
- [Help and Resources](#help-and-resources)
## Setup
In the terminal, install by running
```bash
pip install dart-tools
```
## Using the CLI
Start off by setting up authentication with
```bash
dart login
```
Then, you can create a new task with a command along the lines of
```bash
dart createtask "Update the landing page" -p0 --tag marketing
```
which will make a new task called 'Update the landing page' with priority 'Critical' (i.e. P0) and with the 'marketing' tag.
You can explore all of these options and many more with `dart --help` or the more specific help for subcommands, in this case `dart createtask --help`.
Another common workflow is to updating a preexisting task. To do this, run something like
```bash
dart updatetask [DUID] -s Done
```
This command will mark the referenced task 'Done'. Here `[DUID]` is meant to be replaced (including the brackets) with the 'Dart ID' of an existing task. You can get a DUID from any existing task in a number of ways, such as by copying it from the end of a task's URL or by clicking the '...' button in a task page in Dart and then choosing 'Copy ID'.
## Using the Python Library
First, set up authentication. Run `dart login` in the terminal for an interactive process, or visit [your Dart profile](https://app.itsdart.com/?settings=profile) and then run `dart.login(token)` or save the token into the `DART_TOKEN` environment variable.
Then, you can run something like
```python
import os
from dart import create_task, is_logged_in, update_task
# Check that auth is set up and stop if not, can remove this once everything is set up
is_logged_in(should_raise=True)
# Create a new task called 'Update the landing page'
# With priority 'Critical' (i.e. p0) and with the 'marketing' tag
new_task = create_task(
"Update the landing page", priority_int=0, tag_titles=["marketing"]
)
# Update the task to be 'Done'
update_task(new_task.duid, status_title="Done")
```
## Advanced Usage
Almost anything that can be done in Dart can be done with the Python library, but there are not convenient wrapper functions for everything.
For most advanced usage, the best thing to do is to [get in touch with us](mailto:support@itsdart.com) and we can help.
However, if you want to explore on your own, the client is well-typed, so you can simply explore the code to see what is possible.
All updates will go through the the `dart.transact` function.
As an example, you could run something akin to `update_task` with
```python
from dart import (
Dart,
Operation,
OperationKind,
OperationModelKind,
TaskUpdate,
TransactionKind,
)
# Initialize the inner client
dart = Dart()
# Prepare the update operation
task_update = TaskUpdate(
duid="[DUID]",
size=5,
)
task_update_op = Operation(
model=OperationModelKind.TASK,
kind=OperationKind.UPDATE,
data=task_update,
)
# Call the operation transactionally to preform the update
response = dart.transact([task_update_op], TransactionKind.TASK_UPDATE)
```
## Help and Resources
- [Homepage](https://www.itsdart.com/?nr=1)
- [Web App](https://app.itsdart.com/)
- [Help Center](https://its-dart.notion.site/Dart-Help-Center-8206a2aa2956496f8988b7b32cdcd205)
- [Bugs and Features](https://github.com/its-dart/dart-tools/issues)
- [Library Source](https://github.com/its-dart/dart-tools/)
- [Chat on Discord](https://discord.gg/RExv8jEkSh)
- Email us at [support@itsdart.com](mailto:support@itsdart.com)
Raw data
{
"_id": null,
"home_page": null,
"name": "dart-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "dart, cli, projectmanagement, taskmanagement",
"author": null,
"author_email": "Dart Software Team <software@itsdart.com>",
"download_url": "https://files.pythonhosted.org/packages/79/d8/560a1814e6fd9a9e4a0d2d6513184c133631295d18502f4a9ec737a084d9/dart_tools-0.5.6.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <h1>Dart Tools</h1>\n <p>\n <a href=\"https://pypi.org/project/dart-tools\"><img src=\"https://img.shields.io/pypi/v/dart-tools.svg\" alt=\"PyPI\"></a>\n <a href=\"tox.ini\"><img src=\"https://img.shields.io/pypi/pyversions/dart-tools\" alt=\"Supported Python Versions\"></a>\n <a href=\"LICENSE\"><img src=\"https://img.shields.io/github/license/its-dart/dart-tools\" alt=\"License\"></a>\n </p>\n</div>\n\n[Dart](https://itsdart.com?nr=1) is Project Management powered by AI.\n\n`dart-tools` is the Dart CLI and Python Library. It enables direct integration with Dart through a terminal CLI or through Python.\n\n\n- [Setup](#setup)\n- [Using the CLI](#using-the-cli)\n- [Using the Python Library](#using-the-python-library)\n- [Advanced Usage](#advanced-usage)\n- [Help and Resources](#help-and-resources)\n\n\n## Setup\n\nIn the terminal, install by running\n```bash\npip install dart-tools\n```\n\n\n## Using the CLI\n\nStart off by setting up authentication with\n```bash\ndart login\n```\n\nThen, you can create a new task with a command along the lines of\n```bash\ndart createtask \"Update the landing page\" -p0 --tag marketing\n```\nwhich will make a new task called 'Update the landing page' with priority 'Critical' (i.e. P0) and with the 'marketing' tag.\n\nYou can explore all of these options and many more with `dart --help` or the more specific help for subcommands, in this case `dart createtask --help`.\n\nAnother common workflow is to updating a preexisting task. To do this, run something like\n```bash\ndart updatetask [DUID] -s Done\n```\nThis command will mark the referenced task 'Done'. Here `[DUID]` is meant to be replaced (including the brackets) with the 'Dart ID' of an existing task. You can get a DUID from any existing task in a number of ways, such as by copying it from the end of a task's URL or by clicking the '...' button in a task page in Dart and then choosing 'Copy ID'.\n\n\n## Using the Python Library\n\nFirst, set up authentication. Run `dart login` in the terminal for an interactive process, or visit [your Dart profile](https://app.itsdart.com/?settings=profile) and then run `dart.login(token)` or save the token into the `DART_TOKEN` environment variable.\n\nThen, you can run something like\n```python\nimport os\nfrom dart import create_task, is_logged_in, update_task\n\n# Check that auth is set up and stop if not, can remove this once everything is set up\nis_logged_in(should_raise=True)\n\n# Create a new task called 'Update the landing page'\n# With priority 'Critical' (i.e. p0) and with the 'marketing' tag\nnew_task = create_task(\n \"Update the landing page\", priority_int=0, tag_titles=[\"marketing\"]\n)\n\n# Update the task to be 'Done'\nupdate_task(new_task.duid, status_title=\"Done\")\n```\n\n\n## Advanced Usage\n\nAlmost anything that can be done in Dart can be done with the Python library, but there are not convenient wrapper functions for everything.\nFor most advanced usage, the best thing to do is to [get in touch with us](mailto:support@itsdart.com) and we can help.\n\nHowever, if you want to explore on your own, the client is well-typed, so you can simply explore the code to see what is possible.\nAll updates will go through the the `dart.transact` function.\n\nAs an example, you could run something akin to `update_task` with\n```python\nfrom dart import (\n Dart,\n Operation,\n OperationKind,\n OperationModelKind,\n TaskUpdate,\n TransactionKind,\n)\n\n# Initialize the inner client\ndart = Dart()\n\n# Prepare the update operation\ntask_update = TaskUpdate(\n duid=\"[DUID]\",\n size=5,\n)\ntask_update_op = Operation(\n model=OperationModelKind.TASK,\n kind=OperationKind.UPDATE,\n data=task_update,\n)\n\n# Call the operation transactionally to preform the update\nresponse = dart.transact([task_update_op], TransactionKind.TASK_UPDATE)\n```\n\n\n## Help and Resources\n\n- [Homepage](https://www.itsdart.com/?nr=1)\n- [Web App](https://app.itsdart.com/)\n- [Help Center](https://its-dart.notion.site/Dart-Help-Center-8206a2aa2956496f8988b7b32cdcd205)\n- [Bugs and Features](https://github.com/its-dart/dart-tools/issues)\n- [Library Source](https://github.com/its-dart/dart-tools/)\n- [Chat on Discord](https://discord.gg/RExv8jEkSh)\n- Email us at [support@itsdart.com](mailto:support@itsdart.com)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Dart Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "The Dart CLI and Python Library",
"version": "0.5.6",
"project_urls": {
"Bugs and Features": "https://github.com/its-dart/dart-tools/issues",
"Help Center": "https://its-dart.notion.site/Dart-Help-Center-8206a2aa2956496f8988b7b32cdcd205",
"Homepage": "https://www.itsdart.com/?nr=1",
"Library Source": "https://github.com/its-dart/dart-tools/",
"Web App": "https://app.itsdart.com/"
},
"split_keywords": [
"dart",
" cli",
" projectmanagement",
" taskmanagement"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79d8560a1814e6fd9a9e4a0d2d6513184c133631295d18502f4a9ec737a084d9",
"md5": "d1a99e11afe8559e54d24a0a27eec11b",
"sha256": "fae05f4b0b31b2208631cf9d218c172c6789a6c000a3269df9510d586d6ddb6a"
},
"downloads": -1,
"filename": "dart_tools-0.5.6.tar.gz",
"has_sig": false,
"md5_digest": "d1a99e11afe8559e54d24a0a27eec11b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 90114,
"upload_time": "2024-04-16T22:06:42",
"upload_time_iso_8601": "2024-04-16T22:06:42.945041Z",
"url": "https://files.pythonhosted.org/packages/79/d8/560a1814e6fd9a9e4a0d2d6513184c133631295d18502f4a9ec737a084d9/dart_tools-0.5.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 22:06:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "its-dart",
"github_project": "dart-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dart-tools"
}
