dart-tools 0.6.11__py3-none-any.whl → 0.6.13__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of dart-tools might be problematic. Click here for more details.

@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.2
2
2
  Name: dart-tools
3
- Version: 0.6.11
3
+ Version: 0.6.13
4
4
  Summary: The Dart CLI and Python Library
5
5
  Author-email: Dart Software Team <software@itsdart.com>
6
6
  License: MIT License
@@ -64,8 +64,8 @@ Requires-Dist: requests
64
64
  <div align="center">
65
65
  <h1>Dart Tools</h1>
66
66
  <p>
67
- <a href="https://pypi.org/project/dart-tools"><img src="https://img.shields.io/pypi/v/dart-tools.svg" alt="PyPI"></a>
68
- <a href="tox.ini"><img src="https://img.shields.io/pypi/pyversions/dart-tools" alt="Supported Python Versions"></a>
67
+ <a href="https://pypi.org/project/dart-tools"><img src="https://img.shields.io/pypi/v/dart-tools" alt="PyPI"></a>
68
+ <a href="pyproject.toml"><img src="https://img.shields.io/pypi/pyversions/dart-tools" alt="Supported Python Versions"></a>
69
69
  <a href="LICENSE"><img src="https://img.shields.io/github/license/its-dart/dart-tools" alt="License"></a>
70
70
  </p>
71
71
  </div>
@@ -75,31 +75,35 @@ Requires-Dist: requests
75
75
  `dart-tools` is the Dart CLI and Python Library. It enables direct integration with Dart through a terminal CLI or through Python.
76
76
 
77
77
 
78
- - [Setup](#setup)
78
+ - [Installation](#installation)
79
79
  - [Using the CLI](#using-the-cli)
80
80
  - [Using the Python Library](#using-the-python-library)
81
- - [Using the Python Library in AWS Lambda Functions](#using-the-python-library-in-aws-lambda-functions)
81
+ - [In AWS Lambda Functions](#in-aws-lambda-functions)
82
82
  - [Advanced Usage](#advanced-usage)
83
83
  - [Help and Resources](#help-and-resources)
84
+ - [Contributing](#contributing)
85
+ - [License](#license)
84
86
 
85
87
 
86
- ## Setup
88
+ <a name="installation"></a>
89
+ ## Installation
87
90
 
88
91
  In the terminal, install by running
89
- ```bash
92
+ ```sh
90
93
  pip install dart-tools
91
94
  ```
92
95
 
93
96
 
97
+ <a name="using-the-cli"></a>
94
98
  ## Using the CLI
95
99
 
96
100
  Start off by setting up authentication with
97
- ```bash
101
+ ```sh
98
102
  dart login
99
103
  ```
100
104
 
101
105
  Then, you can create a new task with a command along the lines of
102
- ```bash
106
+ ```sh
103
107
  dart createtask "Update the landing page" -p0 --tag marketing
104
108
  ```
105
109
  which will make a new task called 'Update the landing page' with priority 'Critical' (i.e. P0) and with the 'marketing' tag.
@@ -107,12 +111,13 @@ which will make a new task called 'Update the landing page' with priority 'Criti
107
111
  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`.
108
112
 
109
113
  Another common workflow is to updating a preexisting task. To do this, run something like
110
- ```bash
114
+ ```sh
111
115
  dart updatetask [DUID] -s Done
112
116
  ```
113
117
  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'.
114
118
 
115
119
 
120
+ <a name="using-the-python-library"></a>
116
121
  ## Using the Python Library
117
122
 
118
123
  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.
@@ -125,8 +130,7 @@ from dart import create_task, is_logged_in, update_task
125
130
  # Check that auth is set up and stop if not, can remove this once everything is set up
126
131
  is_logged_in(should_raise=True)
127
132
 
128
- # Create a new task called 'Update the landing page'
129
- # With priority 'Critical' (i.e. p0) and with the 'marketing' tag
133
+ # Create a new task called 'Update the landing page' with priority 'Critical' (i.e. p0) and with the 'marketing' tag
130
134
  new_task = create_task(
131
135
  "Update the landing page", priority_int=0, tag_titles=["marketing"]
132
136
  )
@@ -135,13 +139,15 @@ new_task = create_task(
135
139
  update_task(new_task.duid, status_title="Done")
136
140
  ```
137
141
 
138
- ## Using the Python Library in AWS Lambda Functions
142
+
143
+ <a name="in-aws-lambda-functions"></a>
144
+ ### In AWS Lambda Functions
139
145
 
140
146
  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:
141
147
 
142
148
  1. Navigate to the directory containing your `lambda_function.py` source file. In this example, the directory is named `my_function`.
143
149
 
144
- ```bash
150
+ ```sh
145
151
  cd my_function
146
152
  ```
147
153
 
@@ -149,7 +155,7 @@ To use the `dart-tools` Python library in an AWS Lambda function, you need to pa
149
155
 
150
156
  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:
151
157
 
152
- ```bash
158
+ ```sh
153
159
  export RUNTIME_PYTHON_VERSION=3.12
154
160
  export RUNTIME_ARCHITECTURE=x86_64
155
161
  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"
@@ -159,7 +165,7 @@ To use the `dart-tools` Python library in an AWS Lambda function, you need to pa
159
165
 
160
166
  3. Zip the contents of the `package` directory along with your `lambda_function.py`
161
167
 
162
- ```bash
168
+ ```sh
163
169
  cd package
164
170
  zip -r ../my_deployment_package.zip .
165
171
  cd ..
@@ -172,6 +178,8 @@ To use the `dart-tools` Python library in an AWS Lambda function, you need to pa
172
178
 
173
179
  By following these steps, you can use the `dart-tools` Python library within your AWS Lambda functions.
174
180
 
181
+
182
+ <a name="advanced-usage"></a>
175
183
  ## Advanced Usage
176
184
 
177
185
  Almost anything that can be done in Dart can be done with the Python library, but there are not convenient wrapper functions for everything.
@@ -210,12 +218,25 @@ response = dart.transact([task_update_op], TransactionKind.TASK_UPDATE)
210
218
  ```
211
219
 
212
220
 
221
+ <a name="help-and-resources"></a>
213
222
  ## Help and Resources
214
223
 
215
224
  - [Homepage](https://www.itsdart.com/?nr=1)
216
225
  - [Web App](https://app.itsdart.com/)
217
226
  - [Help Center](https://help.itsdart.com/)
218
- - [Bugs and Features](https://github.com/its-dart/dart-tools/issues)
227
+ - [Bugs and Features](https://app.itsdart.com/p/r/JFyPnhL9En61)
219
228
  - [Library Source](https://github.com/its-dart/dart-tools/)
220
229
  - [Chat on Discord](https://discord.gg/RExv8jEkSh)
221
230
  - Email us at [support@itsdart.com](mailto:support@itsdart.com)
231
+
232
+
233
+ <a name="contributing"></a>
234
+ ## Contributing
235
+
236
+ Contributions are welcome! Please open an issue or submit a pull request.
237
+
238
+
239
+ <a name="license"></a>
240
+ ## License
241
+
242
+ This project is licensed under [the MIT License](LICENSE).
@@ -248,10 +248,10 @@ dart/generated/models/webhook.py,sha256=90ZjBe-oh8hTQMb8CafWTZTUsaj9eHxu85uU-JxT
248
248
  dart/generated/models/webhook_create.py,sha256=kyhv-pI8i4URwul5Ive3hh7TirpDB1YQmio8tn0lkJo,1834
249
249
  dart/generated/models/webhook_update.py,sha256=iy9mx8yyKn9182td88pOnc2H7_4H8xl27m8tV3j8hEI,1916
250
250
  dart/generated/models/zapier_integration.py,sha256=3cKzM0UHNte6Jg-hnroOvgMUHiD7iv1fodrWZoAIaag,1783
251
- dart_tools-0.6.11.dist-info/dist/dart-tools-0.3.3.tar.gz,sha256=JHf6kKcFBOXsnB62lpeV3xcv-GVusi5CysY2tAxgxvk,8788
252
- dart_tools-0.6.11.dist-info/LICENSE,sha256=4ZrQkL_PyaBC3paDrqLnD3knKAXS2i8HwJGyUgRUxls,1061
253
- dart_tools-0.6.11.dist-info/METADATA,sha256=gk-u3-hww0XoZwZeRNSh2T9DtJKitTxqqjd6xWctuos,8904
254
- dart_tools-0.6.11.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
255
- dart_tools-0.6.11.dist-info/entry_points.txt,sha256=KOVAnDWJbSKn9HoXWQ7x6NfACYzSMGHBBaBxonHEv6w,34
256
- dart_tools-0.6.11.dist-info/top_level.txt,sha256=ZwUQ6QjCyi1i32BJOAkbOA7UfgitLmIwToJGJwZXPrg,5
257
- dart_tools-0.6.11.dist-info/RECORD,,
251
+ dart_tools-0.6.13.dist-info/dist/dart-tools-0.3.3.tar.gz,sha256=JHf6kKcFBOXsnB62lpeV3xcv-GVusi5CysY2tAxgxvk,8788
252
+ dart_tools-0.6.13.dist-info/LICENSE,sha256=4ZrQkL_PyaBC3paDrqLnD3knKAXS2i8HwJGyUgRUxls,1061
253
+ dart_tools-0.6.13.dist-info/METADATA,sha256=QWgpjR9T2gMbHuvB71SffA3AvQ-wS_q_TwnfzK7qrco,9308
254
+ dart_tools-0.6.13.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
255
+ dart_tools-0.6.13.dist-info/entry_points.txt,sha256=KOVAnDWJbSKn9HoXWQ7x6NfACYzSMGHBBaBxonHEv6w,34
256
+ dart_tools-0.6.13.dist-info/top_level.txt,sha256=ZwUQ6QjCyi1i32BJOAkbOA7UfgitLmIwToJGJwZXPrg,5
257
+ dart_tools-0.6.13.dist-info/RECORD,,