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_expense_logs()
  • get_day_logs()
  • get_task(task_id)
  • get_overall_focus_time(date)
  • get_habits()
  • complete_task(Task)
  • create_task(Task, column_id)
  • move_task_to_project(Task, project_id)

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.1.tar.gz (11.3 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.1-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tickthon-0.3.1.tar.gz
Algorithm Hash digest
SHA256 84990081bce459ff7be07b999bda547df33ff5be068f5435dd78a9593c7d4d38
MD5 c061581e9f8e801ba9bea862b8453709
BLAKE2b-256 9eb01ad7c2071351043bc6bafedd800a828e3ffae53e4316f6ad4d2317b952bf

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for tickthon-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4d214061b123bd37d7734e72ec26b8272ab61169737dc4593f38709195a137fa
MD5 3a3b5e5126e89145c9fcb1ec61e00958
BLAKE2b-256 3a39435aa318ab3c579b47ba038a7751e8ae05de40f88ed8177f9745501b2f9d

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