dart-tools 0.6.16__tar.gz → 0.7.1__tar.gz

{dart_tools-0.6.16/dart_tools.egg-info → dart_tools-0.7.1}/PKG-INFO

@@ -1,8 +1,8 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: dart-tools
-Version: 0.6.16
+Version: 0.7.1
 Summary: The Dart CLI and Python Library
-Author-email: Dart Software Team <software@itsdart.com>
+Author-email: Dart <software@itsdart.com>
 License: MIT License
         
         Copyright (c) 2023 Dart
@@ -28,8 +28,8 @@ 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://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/
+Project-URL: Bugs and Features, https://github.com/its-dart/dart-tools-py/issues
+Project-URL: Library Source, https://github.com/its-dart/dart-tools-py/
 Keywords: dart,cli,projectmanagement,taskmanagement
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
@@ -59,14 +59,14 @@ Requires-Dist: dateparser
 Requires-Dist: httpx
 Requires-Dist: pick
 Requires-Dist: platformdirs
-Requires-Dist: requests
+Dynamic: license-file
 
 <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" alt="License"></a>
+    <a href="LICENSE"><img src="https://img.shields.io/github/license/its-dart/dart-tools-py" alt="License"></a>
   </p>
 </div>
 
@@ -74,52 +74,63 @@ Requires-Dist: requests
 
 `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)
-- [Advanced Usage](#advanced-usage)
+  - [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 createtask "Update the landing page" -p0 --tag marketing
+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 createtask --help`.
+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 updatetask [DUID] -s Done
+dart task-update [ID] -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'.
 
+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, 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.
+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.itsdart.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
@@ -133,21 +144,20 @@ new_task = create_task(
 )
 
 # Update the task to be 'Done'
-update_task(new_task.duid, status_title="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:
 
-1. 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_function.py` source file. In this example, the directory is named `my_function`.
 
   ```sh
   cd my_function
   ```
 
-2. Create a Deployment Package
+### 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:
 
@@ -159,7 +169,7 @@ To use the `dart-tools` Python library in an AWS Lambda function, you need to pa
 
   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`
+### Zip the contents of the `package` directory along with your `lambda_function.py`
 
   ```sh
   cd package
@@ -168,58 +178,19 @@ To use the `dart-tools` Python library in an AWS Lambda function, you need to pa
   zip -r my_deployment_package.zip lambda_function.py
   ```
 
-4. Deploy the Lambda function
+### 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.
-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 perform the update
-response = dart.transact([task_update_op], TransactionKind.TASK_UPDATE)
-```
-
-
 ## Help and Resources
 
-- [Homepage](https://www.itsdart.com/?nr=1)
+- [Homepage](https://itsdart.com/?nr=1)
 - [Web App](https://app.itsdart.com/)
 - [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/)
+- [Library Source](https://github.com/its-dart/dart-tools-py/)
 - [Chat on Discord](https://discord.gg/RExv8jEkSh)
 - Email us at [support@itsdart.com](mailto:support@itsdart.com)
 

{dart_tools-0.6.16 → dart_tools-0.7.1}/README.md

@@ -3,7 +3,7 @@
   <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" alt="License"></a>
+    <a href="LICENSE"><img src="https://img.shields.io/github/license/its-dart/dart-tools-py" alt="License"></a>
   </p>
 </div>
 
@@ -11,52 +11,63 @@
 
 `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)
-- [Advanced Usage](#advanced-usage)
+  - [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 createtask "Update the landing page" -p0 --tag marketing
+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 createtask --help`.
+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 updatetask [DUID] -s Done
+dart task-update [ID] -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'.
 
+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, 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.
+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.itsdart.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
@@ -70,21 +81,20 @@ new_task = create_task(
 )
 
 # Update the task to be 'Done'
-update_task(new_task.duid, status_title="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:
 
-1. 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_function.py` source file. In this example, the directory is named `my_function`.
 
   ```sh
   cd my_function
   ```
 
-2. Create a Deployment Package
+### 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:
 
@@ -96,7 +106,7 @@ To use the `dart-tools` Python library in an AWS Lambda function, you need to pa
 
   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`
+### Zip the contents of the `package` directory along with your `lambda_function.py`
 
   ```sh
   cd package
@@ -105,58 +115,19 @@ To use the `dart-tools` Python library in an AWS Lambda function, you need to pa
   zip -r my_deployment_package.zip lambda_function.py
   ```
 
-4. Deploy the Lambda function
+### 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.
-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 perform the update
-response = dart.transact([task_update_op], TransactionKind.TASK_UPDATE)
-```
-
-
 ## Help and Resources
 
-- [Homepage](https://www.itsdart.com/?nr=1)
+- [Homepage](https://itsdart.com/?nr=1)
 - [Web App](https://app.itsdart.com/)
 - [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/)
+- [Library Source](https://github.com/its-dart/dart-tools-py/)
 - [Chat on Discord](https://discord.gg/RExv8jEkSh)
 - Email us at [support@itsdart.com](mailto:support@itsdart.com)
 

{dart_tools-0.6.16 → dart_tools-0.7.1}/dart/__init__.py

@@ -1,20 +1,22 @@
 # 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,
+    create_comment,
+    create_doc,
     create_task,
-    get_dartboards,
-    get_folders,
+    delete_doc,
+    delete_task,
     get_host,
     is_logged_in,
     login,
-    replicate_space,
     set_host,
-    update_dartboard,
-    update_folder,
+    update_doc,
     update_task,
 )
+from .generated.models import *
+from .old import get_dartboards, get_folders, replicate_dartboard, replicate_space, update_dartboard, update_folder
 from .webhook import is_signature_correct