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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytodo_qt-0.3.1.tar.gz
  • Upload date:
  • Size: 69.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.1.tar.gz
Algorithm Hash digest
SHA256 0cb4700bce33c2f5c6f7294469c25d0f3a4e26cf9d7854d36b9a5e45dab46015
MD5 894a4fcbe46f3cd11ae901663b0d4f26
BLAKE2b-256 e730dfa31be06b51114e10dd0775dd957ed97a1cc96f22adc262e92b9ff0541e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytodo_qt-0.3.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: pytodo_qt-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 75.4 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a2c41dcbb4f842681d4ba3ebd1bf7a430bd0e699ffca7dfe07b91282746246d4
MD5 0be036bf1f6fe57a32bf6ca4e8bc960e
BLAKE2b-256 7a373d792b80a1198f9af1cf7ef7504c6b9e3c0213d87e539ee059a8e4d8e046

See more details on using hashes here.

Provenance

The following attestation bundles were made for pytodo_qt-0.3.1-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