Skip to main content

Yet another unofficial Ticktick API client, it is based on ticktick-py

Project description

tickthon

Yet another unofficial Ticktick API client, it is based on ticktick-py https://pypi.org/project/ticktick-py/

Installation

pip install tickthon

Usage

from tickthon import TicktickClient, TicktickListIds

client = TicktickClient(username, 
                        password, 
                        TicktickListIds(
                            INBOX="inbox-list-id",
                            TODAY_BACKLOG="today-list-id",
                            WEEK_BACKLOG="week-list-id",
                            MONTH_BACKLOG="month-list-id",
                            WEIGHT_MEASUREMENTS="weight-measurements-list-id"
                        )
            )
client.get_active_tasks()

Features

  • get_active_tasks()
  • get_completed_tasks()
  • get_deleted_tasks()
  • get_abandoned_tasks()
  • get_task(task_id)
  • get_overall_focus_time(date)
  • get_active_focus_time(date, active_focus_tags)
  • get_tasks_by_list(list_ids)
  • complete_task(Task)
  • create_task(Task, column_id)
  • move_task_to_project(Task, project_id)
  • replace_task_tags(Task, tags)

Task model

This package uses a custom attrs model to store task data, it has the following attributes:

Task:

  • title: str
  • status: int, default: 0 # 0: default/open, 2: done, -1: abandoned
  • ticktick_id: str, default: ""
  • focus_time: float, default: 0.0
  • deleted: int, default: 0 # 0: not deleted, 1: deleted
  • tags: List[str], default: []
  • project_id: str, default: ""
  • timezone: str, default: ""
  • due_date: str, default: ""
  • recurrent_id: Optional[str], default: ""

Environment variables

  • TT_USER: Ticktick username
  • TT_PASS: Ticktick password

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tickthon-0.3.6.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tickthon-0.3.6-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file tickthon-0.3.6.tar.gz.

File metadata

  • Download URL: tickthon-0.3.6.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for tickthon-0.3.6.tar.gz
Algorithm Hash digest
SHA256 3c6040c28fe747675c18dc47517b401604c1d441762fc8ffda1899a5e59cf826
MD5 fa5c7b0c9e6cb992ed4f2e09a9806a98
BLAKE2b-256 8ad53b768b786a538add81e82d506f12b3afb925777207b871ef5cfd7a88abc1

See more details on using hashes here.

File details

Details for the file tickthon-0.3.6-py3-none-any.whl.

File metadata

  • Download URL: tickthon-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for tickthon-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 4ac7afd21ef506e05ffe2daf683b5240c79143e11741db9a92eb8b6a3239b72e
MD5 080c5bc288e7c71a89466df97a1783fa
BLAKE2b-256 70a04039f65f3a91e0a963fb17e10aa2697acb4a223ce78501084f376bbe49ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page