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

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

@@ -1,40 +1,18 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: dart-tools
-Version: 0.6.16
+Version: 0.7.0
 Summary: The Dart CLI and Python Library
-Author-email: Dart Software Team <software@itsdart.com>
-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.
-        
+Author-email: Dart <software@itsdart.com>
+License-Expression: MIT
 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
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
@@ -59,14 +37,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>
 
@@ -102,22 +80,22 @@ 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
@@ -133,7 +111,7 @@ 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")
 ```
 
 
@@ -175,51 +153,13 @@ To use the `dart-tools` Python library in an AWS Lambda function, you need to pa
 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)
 - [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.0}/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>
 
@@ -39,22 +39,22 @@ 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
@@ -70,7 +70,7 @@ 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")
 ```
 
 
@@ -112,51 +112,13 @@ To use the `dart-tools` Python library in an AWS Lambda function, you need to pa
 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)
 - [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.0}/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