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.4.tar.gz (11.7 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.4-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tickthon-0.3.4.tar.gz
  • Upload date:
  • Size: 11.7 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.4.tar.gz
Algorithm Hash digest
SHA256 17bb984e6ef298146db8b9667b20c9f14d6cbed68ba21bf538b1e39b05c16012
MD5 9a7577f3a28e1f720bd9b63482e86f77
BLAKE2b-256 d0923bf4cda75387037c810430b96081f03e2814ee8f59f94b01d04af0090ab8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tickthon-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 11.6 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e7645844d34268b56f3d5070f2dfcc925f6d7e56b18ec21a82127d4d29b46d7d
MD5 e199892596983e506c8b01fc6de1eb40
BLAKE2b-256 b9a385563f6260d6ee48a29c960466464576d4b15be7ecfbcbe2775223a91572

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