Skip to main content

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

Project description

pytodo-qt

CI codecov 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

Pre-built Binaries

Download the latest release for your platform from the Releases page.

macOS

  1. Download pytodo-qt-VERSION-macos-arm64.zip (Apple Silicon) or pytodo-qt-VERSION-macos-x86_64.zip (Intel)
  2. Extract the zip file
  3. Move pytodo-qt.app to /Applications or ~/Applications
  4. First run only: Right-click the app and select "Open" to bypass Gatekeeper
    • Alternatively, run: xattr -rd com.apple.quarantine /Applications/pytodo-qt.app
  5. After the first run, you can open normally by double-clicking

Note: The app is ad-hoc signed (not notarized with an Apple Developer ID), so macOS will show an "unidentified developer" warning on first launch. This is normal for open-source software distributed outside the App Store.

Linux

  1. Download pytodo-qt-VERSION-linux-x86_64.tar.gz or pytodo-qt-VERSION-linux-arm64.tar.gz
  2. Extract: tar -xzf pytodo-qt-VERSION-linux-*.tar.gz
  3. Run the install script: cd pytodo-qt-*/ && ./install.sh
  4. Or run directly: ./pytodo-qt

The install script places the binary in ~/.local/bin/ and creates a desktop entry.

To uninstall: ~/.local/lib/pytodo-qt/uninstall.sh (or run ./uninstall.sh from the extracted archive)

Windows

  1. Download pytodo-qt-VERSION-windows-x86_64.zip
  2. Extract the zip file
  3. Run pytodo-qt.exe

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.8.tar.gz (999.2 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.8-py3-none-any.whl (984.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pytodo_qt-0.3.8.tar.gz
  • Upload date:
  • Size: 999.2 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.8.tar.gz
Algorithm Hash digest
SHA256 c48ffaced9060025181f682b702777b93cb8c8519abd9061ede7118a9c96a088
MD5 5418772bad8c2ad16adee88ed295fdf6
BLAKE2b-256 083c2ae40f5ca515934f196832d42037ce4ab11434d8baf52e8a67b25372a9a7

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: pytodo_qt-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 984.0 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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e143d3dc300b2156cdaa59bc94eaa2df3f84fcd17027ffe305986bd040bae9eb
MD5 0165f1dc47789f1ee4ac2d02e6f95cbc
BLAKE2b-256 a9dd034bf9dea70e39495fe80a5001e6e7b425a35ca0ca0d22899591874f2632

See more details on using hashes here.

Provenance

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