| Name | dart-tools JSON |
| Version |
0.8.1
JSON |
| download |
| home_page | None |
| Summary | The Dart CLI and Python Library |
| upload_time | 2025-07-16 01:21:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2025 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" alt="PyPI"></a>
<a href="pyproject.toml"><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-py" alt="License"></a>
</p>
</div>
[Dart](https://dartai.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.
- [Installation](#installation)
- [Naming conflicts](#naming-conflicts)
- [Using the CLI](#using-the-cli)
- [Using the Python Library](#using-the-python-library)
- [Using the Python Library in AWS Lambda Functions](#using-the-python-library-in-aws-lambda-functions)
- [Navigate to the directory containing your `lambda_function.py` source file. In this example, the directory is named `my_function`.](#navigate-to-the-directory-containing-your-lambda_functionpy-source-file-in-this-example-the-directory-is-named-my_function)
- [Create a Deployment Package](#create-a-deployment-package)
- [Zip the contents of the `package` directory along with your `lambda_function.py`](#zip-the-contents-of-the-package-directory-along-with-your-lambda_functionpy)
- [Deploy the Lambda function](#deploy-the-lambda-function)
- [Help and Resources](#help-and-resources)
- [Contributing](#contributing)
- [License](#license)
## Installation
In the terminal, install by running
```sh
pip install dart-tools
```
### Naming conflicts
If you have a preexisting shell command named `dart`, a quick fix is to run `which -a dart` and fine the path for this `dart` application. Then you can create an alias and add it to your shell profile file (`.zshrc`, `.bashrc`, etc.). For example, open `~/.zshrc` and add a line like `alias dartai="/path/to/dart"`, save it, and restart your terminal.
## Using the CLI
Start off by setting up authentication with
```sh
dart login
```
Then, you can create a new task with a command along the lines of
```sh
dart task-create "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 task-create --help`.
Another common workflow is to updating a preexisting task. To do this, run something like
```sh
dart task-update [ID] -s Done
```
This command will mark the referenced task 'Done'. Here `[ID]` is meant to be replaced (including the brackets) with the ID of an existing task. You can get a ID 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. Alternatively, copy your authentication token from [your Dart profile](https://app.dartai.com/?settings=account) and save that as 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.id, status_title="Done")
```
## Using the Python Library in AWS Lambda Functions
To use the `dart-tools` Python library in an AWS Lambda function, you need to package the library with your Lambda deployment package (see more details at [Working with .zip file archives for Python Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html)). Follow these steps:
### Navigate to the directory containing your `lambda_function.py` source file. In this example, the directory is named `my_function`.
```sh
cd my_function
```
### Create a Deployment Package
Use Docker to create a deployment package that includes the `dart-tools` library. Run the following commands in your terminal, ensuring that the `RUNTIME_PYTHON_VERSION` and `RUNTIME_ARCHITECTURE` environment variables match the runtime settings of your Lambda function:
```sh
export RUNTIME_PYTHON_VERSION=3.12
export RUNTIME_ARCHITECTURE=x86_64
docker run --rm --volume ${PWD}:/app --entrypoint /bin/bash public.ecr.aws/lambda/python:${RUNTIME_PYTHON_VERSION}-${RUNTIME_ARCHITECTURE} -c "pip install --target /app/package dart-tools"
```
This command installs the `dart-tools` library into a directory named `package` in your current working directory.
### Zip the contents of the `package` directory along with your `lambda_function.py`
```sh
cd package
zip -r ../my_deployment_package.zip .
cd ..
zip -r my_deployment_package.zip lambda_function.py
```
### Deploy the Lambda function
Upload the `my_deployment_package.zip` file to AWS Lambda using the AWS Management Console or the AWS CLI.
By following these steps, you can use the `dart-tools` Python library within your AWS Lambda functions.
## Help and Resources
- [Homepage](https://dartai.com/?nr=1)
- [Web App](https://app.dartai.com/)
- [Help Center](https://help.dartai.com/)
- [Bugs and Features](https://app.dartai.com/p/r/JFyPnhL9En61)
- [Library Source](https://github.com/its-dart/dart-tools-py/)
- [Chat on Discord](https://discord.gg/RExv8jEkSh)
- Email us at [support@dartai.com](mailto:support@dartai.com)
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License
This project is licensed under [the MIT License](LICENSE).
Raw data
{
"_id": null,
"home_page": null,
"name": "dart-tools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "dart, cli, projectmanagement, taskmanagement",
"author": null,
"author_email": "Dart <software@dartai.com>",
"download_url": "https://files.pythonhosted.org/packages/f0/6c/1b67337f180795985301c674509c372bb9cb6eee24b06e520e3cf5853464/dart_tools-0.8.1.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\" alt=\"PyPI\"></a>\n <a href=\"pyproject.toml\"><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-py\" alt=\"License\"></a>\n </p>\n</div>\n\n[Dart](https://dartai.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- [Installation](#installation)\n - [Naming conflicts](#naming-conflicts)\n- [Using the CLI](#using-the-cli)\n- [Using the Python Library](#using-the-python-library)\n- [Using the Python Library in AWS Lambda Functions](#using-the-python-library-in-aws-lambda-functions)\n - [Navigate to the directory containing your `lambda_function.py` source file. In this example, the directory is named `my_function`.](#navigate-to-the-directory-containing-your-lambda_functionpy-source-file-in-this-example-the-directory-is-named-my_function)\n - [Create a Deployment Package](#create-a-deployment-package)\n - [Zip the contents of the `package` directory along with your `lambda_function.py`](#zip-the-contents-of-the-package-directory-along-with-your-lambda_functionpy)\n - [Deploy the Lambda function](#deploy-the-lambda-function)\n- [Help and Resources](#help-and-resources)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\nIn the terminal, install by running\n\n```sh\npip install dart-tools\n```\n\n### Naming conflicts\n\nIf you have a preexisting shell command named `dart`, a quick fix is to run `which -a dart` and fine the path for this `dart` application. Then you can create an alias and add it to your shell profile file (`.zshrc`, `.bashrc`, etc.). For example, open `~/.zshrc` and add a line like `alias dartai=\"/path/to/dart\"`, save it, and restart your terminal.\n\n## Using the CLI\n\nStart off by setting up authentication with\n\n```sh\ndart login\n```\n\nThen, you can create a new task with a command along the lines of\n\n```sh\ndart task-create \"Update the landing page\" -p0 --tag marketing\n```\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 task-create --help`.\n\nAnother common workflow is to updating a preexisting task. To do this, run something like\n\n```sh\ndart task-update [ID] -s Done\n```\n\nThis command will mark the referenced task 'Done'. Here `[ID]` is meant to be replaced (including the brackets) with the ID of an existing task. You can get a ID 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## Using the Python Library\n\nFirst, set up authentication. Run `dart login` in the terminal for an interactive process. Alternatively, copy your authentication token from [your Dart profile](https://app.dartai.com/?settings=account) and save that as the `DART_TOKEN` environment variable.\n\nThen, you can run something like\n\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' 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.id, status_title=\"Done\")\n```\n\n## Using the Python Library in AWS Lambda Functions\n\nTo use the `dart-tools` Python library in an AWS Lambda function, you need to package the library with your Lambda deployment package (see more details at [Working with .zip file archives for Python Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html)). Follow these steps:\n\n### Navigate to the directory containing your `lambda_function.py` source file. In this example, the directory is named `my_function`.\n\n ```sh\n cd my_function\n ```\n\n### Create a Deployment Package\n\n Use Docker to create a deployment package that includes the `dart-tools` library. Run the following commands in your terminal, ensuring that the `RUNTIME_PYTHON_VERSION` and `RUNTIME_ARCHITECTURE` environment variables match the runtime settings of your Lambda function:\n\n ```sh\n export RUNTIME_PYTHON_VERSION=3.12\n export RUNTIME_ARCHITECTURE=x86_64\n docker run --rm --volume ${PWD}:/app --entrypoint /bin/bash public.ecr.aws/lambda/python:${RUNTIME_PYTHON_VERSION}-${RUNTIME_ARCHITECTURE} -c \"pip install --target /app/package dart-tools\"\n ```\n\n This command installs the `dart-tools` library into a directory named `package` in your current working directory.\n\n### Zip the contents of the `package` directory along with your `lambda_function.py`\n\n ```sh\n cd package\n zip -r ../my_deployment_package.zip .\n cd ..\n zip -r my_deployment_package.zip lambda_function.py\n ```\n\n### Deploy the Lambda function\n\n Upload the `my_deployment_package.zip` file to AWS Lambda using the AWS Management Console or the AWS CLI.\n\nBy following these steps, you can use the `dart-tools` Python library within your AWS Lambda functions.\n\n## Help and Resources\n\n- [Homepage](https://dartai.com/?nr=1)\n- [Web App](https://app.dartai.com/)\n- [Help Center](https://help.dartai.com/)\n- [Bugs and Features](https://app.dartai.com/p/r/JFyPnhL9En61)\n- [Library Source](https://github.com/its-dart/dart-tools-py/)\n- [Chat on Discord](https://discord.gg/RExv8jEkSh)\n- Email us at [support@dartai.com](mailto:support@dartai.com)\n\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request.\n\n\n## License\n\nThis project is licensed under [the MIT License](LICENSE).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2025 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.8.1",
"project_urls": {
"Bugs and Features": "https://github.com/its-dart/dart-tools-py/issues",
"Help Center": "https://help.dartai.com/",
"Homepage": "https://www.dartai.com/?nr=1",
"Library Source": "https://github.com/its-dart/dart-tools-py/",
"Web App": "https://app.dartai.com/"
},
"split_keywords": [
"dart",
" cli",
" projectmanagement",
" taskmanagement"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "21eb9c054f03fd0907eaf58c9e0e92f017b7287bf0ecb4a6474676c8e91a5f68",
"md5": "3f005d346c5cd5f055d495e568706451",
"sha256": "8c37a2ab89a4c73ac01fe43135a9959c54365f65c8870b9c3c8c0dbf91372f98"
},
"downloads": -1,
"filename": "dart_tools-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f005d346c5cd5f055d495e568706451",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 90605,
"upload_time": "2025-07-16T01:21:45",
"upload_time_iso_8601": "2025-07-16T01:21:45.377874Z",
"url": "https://files.pythonhosted.org/packages/21/eb/9c054f03fd0907eaf58c9e0e92f017b7287bf0ecb4a6474676c8e91a5f68/dart_tools-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "f06c1b67337f180795985301c674509c372bb9cb6eee24b06e520e3cf5853464",
"md5": "aedb092a306246cd8bd61cce47c30428",
"sha256": "87f4e602d7d2c504182592b53b93664ec496674ebc0960871e7f6b7543a1f0d2"
},
"downloads": -1,
"filename": "dart_tools-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "aedb092a306246cd8bd61cce47c30428",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 43108,
"upload_time": "2025-07-16T01:21:46",
"upload_time_iso_8601": "2025-07-16T01:21:46.812801Z",
"url": "https://files.pythonhosted.org/packages/f0/6c/1b67337f180795985301c674509c372bb9cb6eee24b06e520e3cf5853464/dart_tools-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 01:21:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "its-dart",
"github_project": "dart-tools-py",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dart-tools"
}
