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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tickthon-0.3.5.tar.gz
  • Upload date:
  • Size: 11.8 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.5.tar.gz
Algorithm Hash digest
SHA256 baf882a93ea490d7247155f2f1ed13da613e2f2617106bcccff543515ed58420
MD5 3968e3e6c28e0d389c238c730fd66f9b
BLAKE2b-256 af5b3cccc581eede7d21cd2aedb54b2fefb9ad31948650feda19fcad70b8091e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tickthon-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 11.7 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 54f0028eb06ffb8c68b0816b05be196a83c596e6dbd23aad946cbf8878ec8ecf
MD5 71d99cd044b6ab610ccdf7660549075d
BLAKE2b-256 f18d219c0e6159d8ba74206c59230337bb6938ef5e5bee282a981bd754b14eeb

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