Skip to main content

A tiny DSL for calendar interval algebra - compose, filter, and query time ranges using set operations.

Project description

calgebra 🗓️

A tiny DSL for merging and searching over calendar-like intervals.

Installation

pip install calgebra

# Or with Google Calendar support
pip install calgebra[google-calendar]

Quick Start

from calgebra import day_of_week, time_of_day, hours, at_tz, HOUR
from itertools import islice

# Compose time windows
weekdays = day_of_week(["monday", "tuesday", "wednesday", "thursday", "friday"])
work_hours = time_of_day(start=9*HOUR, duration=8*HOUR, tz="US/Pacific")
business_hours = weekdays & work_hours

# Find free time
busy = monday_meetings | friday_focus
free = business_hours - busy
long_slots = free & (hours >= 2)

# Query results (forward)
at = at_tz("US/Pacific")
meeting_options = list(long_slots[at("2025-01-01"):at("2025-02-01")])

# Query in reverse (last 5 events)
last_5 = list(islice(calendar[at("2024-01-01"):at("2025-01-01"):-1], 5))

Intervals use exclusive end bounds ([start, end)), matching Python slicing. Interval(start=10, end=13) represents 3 seconds. Intervals are automatically clipped to query bounds.

Core Features:

  • Set operations: | (union), & (intersection), - (difference), ~ (complement)
  • Recurring patterns: recurring(), day_of_week(), time_of_day() (RFC 5545 via python-dateutil)
  • Reverse iteration: timeline[end:start:-1] for reverse chronological order
  • Aggregations: total_duration, max_duration, min_duration, count_intervals, coverage_ratio
  • Transformations: buffer() (add time around intervals), merge_within() (coalesce nearby intervals)
  • Google Calendar: calgebra.gcsa.calendars() for read/write operations

**→ Quick-start | Tutorial | API Reference | Google Calendar

License

MIT License - see LICENSE file for details.

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

calgebra-0.8.1.tar.gz (86.9 kB view details)

Uploaded Source

Built Distribution

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

calgebra-0.8.1-py3-none-any.whl (68.4 kB view details)

Uploaded Python 3

File details

Details for the file calgebra-0.8.1.tar.gz.

File metadata

  • Download URL: calgebra-0.8.1.tar.gz
  • Upload date:
  • Size: 86.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for calgebra-0.8.1.tar.gz
Algorithm Hash digest
SHA256 26d4ddd884ba299ac92991ea5f80a268180f7f93495bf714b38cfd3d755ee911
MD5 e2db63b8fa9c0009fe15faeabb106368
BLAKE2b-256 1f6e841e369fc6b9966376372315c9fd54541ee15d05a5bb822e2a54ee47bef0

See more details on using hashes here.

File details

Details for the file calgebra-0.8.1-py3-none-any.whl.

File metadata

  • Download URL: calgebra-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 68.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for calgebra-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 06fbb1976a9e9064aa890f7cf5fb8db1bbe1512108c13a0efa8ea6239770b934
MD5 805a3952da3d4680e15a40fc89aeb98d
BLAKE2b-256 6484d236cd409a03b4aca89ea7ceac21d91119297b40af43331a43f081337a42

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