Skip to content

Commit a406e14

Browse files
committed
Prepare README and other documents for public release (#38)
* Add Dependabot support * Update README.md Co-authored-by: Scott Lovegrove <scott@doist.com> * Update README.md Co-authored-by: Jan Kratochvíl <kratochvil.jan@outlook.com> * Update README.md Co-authored-by: Jan Kratochvíl <kratochvil.jan@outlook.com> * Update README.md Co-authored-by: Jan Kratochvíl <kratochvil.jan@outlook.com> * Update README.md Co-authored-by: Jan Kratochvíl <kratochvil.jan@outlook.com> * Update README.md * Co-authored-by: Jan Kratochvíl <kratochvil.jan@outlook.com> Update README.md * Co-authored-by: Jan Kratochvíl <kratochvil.jan@outlook.com>
1 parent f18ba70 commit a406e14

File tree

5 files changed

+57
-11
lines changed

5 files changed

+57
-11
lines changed

.github/CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @Doist/Integrations

.github/dependabot.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: 'pip'
4+
directory: '/'
5+
schedule:
6+
interval: 'monthly'

CHANGELOG.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
3+
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
## [Unreleased]
8+
9+
## [2.0.0] - 2021-11-22
10+
### Added
11+
- Public release

README.md

+28-11
Original file line numberDiff line numberDiff 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.
34

45
### Installation
56

67
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:
78

89
```
910
[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"
1112
```
1213

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+
1318
### Usage
1419

1520
An example of initializing the API client and fetching a user's tasks:
@@ -20,7 +25,7 @@ from todoist_api_python.api import TodoistAPI
2025

2126
# Fetch tasks asynchronously
2227
async def get_tasks_async():
23-
api = TodoistAPIAsync("my token")
28+
api = TodoistAPIAsync("YOURTOKEN")
2429
try:
2530
tasks = await api.get_tasks()
2631
print(tasks)
@@ -37,6 +42,10 @@ def get_tasks_sync():
3742
print(error)
3843
```
3944

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+
4049
### Development
4150

4251
To install Python dependencies:
@@ -57,12 +66,20 @@ You can try your changes via REPL by running:
5766
$ poetry run python
5867
```
5968

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.
6482

65-
### Releasing
83+
### Contributions
6684

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.

SECURITY.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
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

Comments
 (0)