dart-tools 0.5.5__tar.gz → 0.6.12__tar.gz

{dart-tools-0.5.5 → dart_tools-0.6.12}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: dart-tools
-Version: 0.5.5
+Version: 0.6.12
 Summary: The Dart CLI and Python Library
 Author-email: Dart Software Team <software@itsdart.com>
 License: MIT License
@@ -27,7 +27,7 @@ License: MIT License
         
 Project-URL: Homepage, https://www.itsdart.com/?nr=1
 Project-URL: Web App, https://app.itsdart.com/
-Project-URL: Help Center, https://its-dart.notion.site/Dart-Help-Center-8206a2aa2956496f8988b7b32cdcd205
+Project-URL: Help Center, https://help.itsdart.com/
 Project-URL: Bugs and Features, https://github.com/its-dart/dart-tools/issues
 Project-URL: Library Source, https://github.com/its-dart/dart-tools/
 Keywords: dart,cli,projectmanagement,taskmanagement
@@ -40,30 +40,32 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Office/Business
 Classifier: Topic :: Office/Business :: Groupware
 Classifier: Topic :: Office/Business :: Scheduling
 Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: attrs
 Requires-Dist: dateparser
+Requires-Dist: httpx
 Requires-Dist: pick
-Requires-Dist: requests
 Requires-Dist: platformdirs
+Requires-Dist: requests
 
 <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="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" alt="License"></a>
   </p>
 </div>
@@ -73,17 +75,20 @@ Requires-Dist: platformdirs
 `dart-tools` is the Dart CLI and Python Library. It enables direct integration with Dart through a terminal CLI or through Python.
 
 
-- [Setup](#setup)
+- [Installation](#installation)
 - [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)
 - [Advanced Usage](#advanced-usage)
 - [Help and Resources](#help-and-resources)
+- [Contributing](#contributing)
+- [License](#license)
 
 
-## Setup
+## Installation
 
 In the terminal, install by running
-```bash
+```sh
 pip install dart-tools
 ```
 
@@ -91,12 +96,12 @@ pip install dart-tools
 ## Using the CLI
 
 Start off by setting up authentication with
-```bash
+```sh
 dart login
 ```
 
 Then, you can create a new task with a command along the lines of
-```bash
+```sh
 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.
@@ -104,7 +109,7 @@ which will make a new task called 'Update the landing page' with priority 'Criti
 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
+```sh
 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'.
@@ -112,7 +117,7 @@ This command will mark the referenced task 'Done'. Here `[DUID]` is meant to be
 
 ## 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.
+First, set up authentication. Run `dart login` in the terminal for an interactive process, or visit [your Dart profile](https://app.itsdart.com/?settings=account) and then run `dart.login(token)` or save the token into the `DART_TOKEN` environment variable.
 
 Then, you can run something like
 ```python
@@ -122,8 +127,7 @@ 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
+# 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"]
 )
@@ -133,6 +137,44 @@ update_task(new_task.duid, 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:
+
+1. Navigate to the directory containing your `lambda_function.py` source file. In this example, the directory is named `my_function`.
+
+  ```sh
+  cd my_function
+  ```
+
+2. 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.
+
+3. 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
+  ```
+
+4. 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.
+
+
 ## 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.
@@ -166,7 +208,7 @@ task_update_op = Operation(
     data=task_update,
 )
 
-# Call the operation transactionally to preform the update
+# Call the operation transactionally to perform the update
 response = dart.transact([task_update_op], TransactionKind.TASK_UPDATE)
 ```
 
@@ -175,8 +217,18 @@ response = dart.transact([task_update_op], TransactionKind.TASK_UPDATE)
 
 - [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)
+- [Help Center](https://help.itsdart.com/)
+- [Bugs and Features](https://app.itsdart.com/p/r/JFyPnhL9En61)
 - [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)
+
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+
+## License
+
+This project is licensed under [the MIT License](LICENSE).

{dart-tools-0.5.5 → dart_tools-0.6.12}/README.md

@@ -1,8 +1,8 @@
 <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="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" alt="License"></a>
   </p>
 </div>
@@ -12,17 +12,20 @@
 `dart-tools` is the Dart CLI and Python Library. It enables direct integration with Dart through a terminal CLI or through Python.
 
 
-- [Setup](#setup)
+- [Installation](#installation)
 - [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)
 - [Advanced Usage](#advanced-usage)
 - [Help and Resources](#help-and-resources)
+- [Contributing](#contributing)
+- [License](#license)
 
 
-## Setup
+## Installation
 
 In the terminal, install by running
-```bash
+```sh
 pip install dart-tools
 ```
 
@@ -30,12 +33,12 @@ pip install dart-tools
 ## Using the CLI
 
 Start off by setting up authentication with
-```bash
+```sh
 dart login
 ```
 
 Then, you can create a new task with a command along the lines of
-```bash
+```sh
 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.
@@ -43,7 +46,7 @@ which will make a new task called 'Update the landing page' with priority 'Criti
 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
+```sh
 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'.
@@ -51,7 +54,7 @@ This command will mark the referenced task 'Done'. Here `[DUID]` is meant to be
 
 ## 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.
+First, set up authentication. Run `dart login` in the terminal for an interactive process, or visit [your Dart profile](https://app.itsdart.com/?settings=account) and then run `dart.login(token)` or save the token into the `DART_TOKEN` environment variable.
 
 Then, you can run something like
 ```python
@@ -61,8 +64,7 @@ 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
+# 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"]
 )
@@ -72,6 +74,44 @@ update_task(new_task.duid, 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:
+
+1. Navigate to the directory containing your `lambda_function.py` source file. In this example, the directory is named `my_function`.
+
+  ```sh
+  cd my_function
+  ```
+
+2. 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.
+
+3. 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
+  ```
+
+4. 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.
+
+
 ## 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.
@@ -105,7 +145,7 @@ task_update_op = Operation(
     data=task_update,
 )
 
-# Call the operation transactionally to preform the update
+# Call the operation transactionally to perform the update
 response = dart.transact([task_update_op], TransactionKind.TASK_UPDATE)
 ```
 
@@ -114,8 +154,18 @@ response = dart.transact([task_update_op], TransactionKind.TASK_UPDATE)
 
 - [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)
+- [Help Center](https://help.itsdart.com/)
+- [Bugs and Features](https://app.itsdart.com/p/r/JFyPnhL9En61)
 - [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)
+
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request.
+
+
+## License
+
+This project is licensed under [the MIT License](LICENSE).

{dart-tools-0.5.5 → dart_tools-0.6.12}/dart/__init__.py

@@ -1,13 +1,20 @@
+# Required for type hinting compatibility when using Python 3.9
+from __future__ import annotations
 from .generated.models import *
 from .dart import (
     Dart,
+    begin_task,
     cli,
-    set_host,
+    create_task,
+    get_dartboards,
+    get_folders,
+    get_host,
     is_logged_in,
     login,
-    create_task,
-    update_task,
-    begin_task,
     replicate_space,
+    set_host,
+    update_dartboard,
+    update_folder,
+    update_task,
 )
 from .webhook import is_signature_correct