Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/konikvranik/hacs_ticktick
TickCick TODO integration for Home Assistant
https://github.com/konikvranik/hacs_ticktick
hacs hacs-integration hass home-assistant home-automation ticktick ticktick-api todo todo-list todolist
Last synced: 30 days ago
JSON representation
TickCick TODO integration for Home Assistant
- Host: GitHub
- URL: https://github.com/konikvranik/hacs_ticktick
- Owner: konikvranik
- License: mit
- Created: 2024-11-08T06:46:36.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-01-13T17:01:04.000Z (about 1 month ago)
- Last Synced: 2025-01-13T17:47:47.217Z (about 1 month ago)
- Topics: hacs, hacs-integration, hass, home-assistant, home-automation, ticktick, ticktick-api, todo, todo-list, todolist
- Language: Python
- Homepage: https://github.com/konikvranik/hacs_ticktick
- Size: 197 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TickTick API
OpenAPI that allows the user to create and manage a TODO list using ChatGPT.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: v1
- Package version: 1.0.0
- Generator version: 7.11.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import custom_components.ticktick_todo.pyticktick.openapi_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import custom_components.ticktick_todo.pyticktick.openapi_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import custom_components.ticktick_todo.pyticktick.openapi_client
from custom_components.ticktick_todo.pyticktick.openapi_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://ticktick.com
# See configuration.py for a list of all supported configuration parameters.
configuration = custom_components.ticktick_todo.pyticktick.openapi_client.Configuration(
host = "https://ticktick.com"
)
# Enter a context with an instance of the API client
async with custom_components.ticktick_todo.pyticktick.openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = custom_components.ticktick_todo.pyticktick.openapi_client.DefaultApi(api_client)
project_id = 'project_id_example' # str | The ID of project which task in
task_id = 'task_id_example' # str | The ID of task
try:
# Complete a task by project ID and task ID
await api_instance.complete_specify_task(project_id, task_id)
except ApiException as e:
print("Exception when calling DefaultApi->complete_specify_task: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://ticktick.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**complete_specify_task**](docs/DefaultApi.md#complete_specify_task) | **POST** /open/v1/project/{projectId}/task/{taskId}/complete | Complete a task by project ID and task ID
*DefaultApi* | [**create_single_task**](docs/DefaultApi.md#create_single_task) | **POST** /open/v1/task | Create a task to TickTick
*DefaultApi* | [**delete_specify_task**](docs/DefaultApi.md#delete_specify_task) | **DELETE** /open/v1/project/{projectId}/task/{taskId} | Delete a task by project ID and task ID
*DefaultApi* | [**get_all_projects**](docs/DefaultApi.md#get_all_projects) | **GET** /open/v1/project | Get the list of projects
*DefaultApi* | [**get_project_by_id**](docs/DefaultApi.md#get_project_by_id) | **GET** /open/v1/project/{projectId} | Get a project by ID
*DefaultApi* | [**get_project_with_data_by_id**](docs/DefaultApi.md#get_project_with_data_by_id) | **GET** /open/v1/project/{projectId}/data | Get project with data by ID
## Documentation For Models
- [ChecklistItem](docs/ChecklistItem.md)
- [Column](docs/Column.md)
- [Project](docs/Project.md)
- [ProjectData](docs/ProjectData.md)
- [Task](docs/Task.md)
## Documentation For Authorization
Endpoints do not require authorization.
## Author