Skip to main content

A cross-platform to-do list manager with encrypted peer-to-peer synchronization

Project description

pytodo-qt

CI Python 3.11+ License: GPL v3 Ruff Code style: black

A cross-platform to-do list manager with encrypted peer-to-peer synchronization.

Features

  • Multiple lists - Organize tasks into separate lists
  • Priority levels - High, normal, and low priority with color coding
  • Encrypted sync - AES-256-GCM encryption with Ed25519 key exchange
  • Auto-discovery - Find other instances on your network via mDNS/Zeroconf
  • Dark/light themes - System-following or manual theme selection
  • Cross-platform - Linux, macOS, and Windows support

Requirements

  • Python 3.11 or later
  • PyQt6

Installation

From PyPI

pipx install pytodo-qt    # recommended
pip install pytodo-qt     # alternative

From source

git clone https://github.com/berrym/pytodo-qt.git
cd pytodo-qt
pip install .

Development install

pip install -e ".[dev]"

Usage

pytodo-qt

Command-line options

Server Options:
  -s, --server {yes,no}    enable/disable network server
  --pull {yes,no}          allow remote pull requests
  --push {yes,no}          allow remote push requests
  -i, --ip IP              server bind address
  -p, --port PORT          server port

Discovery Options:
  -d, --discovery {yes,no} enable/disable mDNS discovery

Appearance Options:
  -t, --theme {light,dark,system}

Configuration

Configuration is stored in XDG-compliant locations:

Platform Config Data
Linux ~/.config/pytodo-qt/ ~/.local/share/pytodo-qt/
macOS ~/Library/Application Support/pytodo-qt/ same
Windows %APPDATA%\pytodo-qt\ same

config.toml

[database]
active_list = ""
sort_key = "priority"
reverse_sort = false

[server]
enabled = true
address = "0.0.0.0"
port = 5364
allow_pull = true
allow_push = true

[discovery]
enabled = true
service_name = ""  # defaults to pytodo-{hostname}

[appearance]
theme = "system"  # light, dark, system

Synchronization

pytodo-qt uses a secure peer-to-peer protocol for syncing between instances:

  1. Discovery - Instances advertise themselves via mDNS (_pytodo._tcp.local.)
  2. Key exchange - Ed25519 identity keys with X25519 ephemeral session keys
  3. Encryption - All data encrypted with AES-256-GCM
  4. Merge - Last-write-wins conflict resolution with UUID-based items

Identity keys are stored in your system keyring (GNOME Keyring, macOS Keychain, Windows Credential Locker).

Development

# Install dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Lint and format
ruff check src/ tests/
ruff format src/ tests/

# Type check
basedpyright src/

License

GPLv3 or later. See COPYING for details.

Copyright 2024 Michael Berry trismegustis@gmail.com

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

pytodo_qt-0.3.5.tar.gz (938.3 kB view details)

Uploaded Source

Built Distribution

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

pytodo_qt-0.3.5-py3-none-any.whl (942.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytodo_qt-0.3.5.tar.gz
  • Upload date:
  • Size: 938.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pytodo_qt-0.3.5.tar.gz
Algorithm Hash digest
SHA256 c9a118c0c964bfc0f5f5c83c84e356bd35fa8c8233bf3d40893340961feb733a
MD5 ad3ea27192554d8b25aa14e9960baf3c
BLAKE2b-256 92e518f11ff71854a508807e7cadc9ba1ce6d97ce741460a7612472bb12edaf1

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytodo_qt-0.3.5.tar.gz:

Publisher: publish.yml on berrym/pytodo-qt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: pytodo_qt-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 942.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pytodo_qt-0.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 85c57a84a06403324cbb9b99f80ce4e00c9b37e492eac7778ce32ff792bfc204
MD5 553c2694f5330b16a2d4f64b8956dc64
BLAKE2b-256 0044c1c4ee7d3529d12a882509b9bc7cf96974b12f84ed3c18105cf8bee7a336

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytodo_qt-0.3.5-py3-none-any.whl:

Publisher: publish.yml on berrym/pytodo-qt

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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