You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-11
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,20 @@
1
-
# todoist-api-python
2
-
A python wrapper for the Todoist REST API.
1
+
# Todoist API Python Client
2
+
3
+
This is the official Python API client for the Todoist REST API.
3
4
4
5
### Installation
5
6
6
7
The repository can be included as a Poetry dependency in `pyproject.toml`, it is best to integrate to a release tag to ensure a stable dependency:
7
8
8
9
```
9
10
[tool.poetry.dependencies]
10
-
todoist-api-python = { git = "ssh://git@github.com/Doist/todoist-api-python.git", tag = "v1.x.x" }
11
+
todoist-api-python = "^v2.0.0"
11
12
```
12
13
14
+
### Supported Python Versions
15
+
16
+
Python 3.8 is fully supported and tested, and while it may work with other Python 3 versions, we do not test for them.
17
+
13
18
### Usage
14
19
15
20
An example of initializing the API client and fetching a user's tasks:
@@ -20,7 +25,7 @@ from todoist_api_python.api import TodoistAPI
20
25
21
26
# Fetch tasks asynchronously
22
27
asyncdefget_tasks_async():
23
-
api = TodoistAPIAsync("my token")
28
+
api = TodoistAPIAsync("YOURTOKEN")
24
29
try:
25
30
tasks =await api.get_tasks()
26
31
print(tasks)
@@ -37,6 +42,10 @@ def get_tasks_sync():
37
42
print(error)
38
43
```
39
44
45
+
### Documentation
46
+
47
+
For more detailed reference documentation, have a look at the [API documentation with Python examples](https://developer.todoist.com/rest/v1/?python).
48
+
40
49
### Development
41
50
42
51
To install Python dependencies:
@@ -57,12 +66,20 @@ You can try your changes via REPL by running:
57
66
$ poetry run python
58
67
```
59
68
60
-
You can then import the library as describe in [Usage)(#usage) without having to
61
-
create a file. Keep in mind that you have to `import asyncio` and run
62
-
`asyncio.run(yourmethod())` to make your async methods run as expected if you
63
-
decide to use `TodoistAPIAsync`.
69
+
You can then import the library as describe in [Usage](#usage) without having to create a file. Keep in mind that you have to `import asyncio` and run `asyncio.run(yourmethod())` to make your async methods run as expected if you decide to use `TodoistAPIAsync`.
70
+
71
+
### Releases
72
+
73
+
This API client is public, and available in a PyPI repository.
74
+
75
+
A new update is automatically released by GitHub Actions, by creating a release with a tag in the format `vX.Y.Z` (`v<Major>.<Minor>.<Patch>`).
76
+
77
+
Users of the API client can then update to the new version in their `pyproject.toml` file.
78
+
79
+
### Feedback
80
+
81
+
Any feedback, such as bugs, questions, comments, etc. can be reported as *Issues* in this repository, and will be handled by Doist.
64
82
65
-
### Releasing
83
+
### Contributions
66
84
67
-
The SDK is currently private so it not published to PyPI. To release a new update just create a release with a tag
68
-
in the format `v1.x.x` and any consumers can update to this tag in their `pyproject.toml`.
85
+
We would love contributions in the form of *Pull requests* in this repository.
Only the latest released version is being supported with security updates.
6
+
7
+
## Reporting a Vulnerability
8
+
9
+
If you discover any security vulnerability, please open an Issue at the project's GitHub repository, and we'll do our best to fix it right away.
10
+
11
+
At Doist, our bug bounty program is a critical component of our security efforts. Your efforts may be eligible for a monetary reward. For more see our [Doist bug bounty policy](https://todoist.com/help/articles/doist-bug-bounty-policy).
0 commit comments