pyremindkit

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 31)

Simple wrapper for Apple Reminders API (WIP)

pyremindkit Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# PyRemindKit

A Python package that a simple wrapper over Apple Reminders API

## Features

### Reminder Management
- **Create reminders** with customizable attributes (title, due date, notes, priority, URL)
- **Update reminders** - modify title, due date, notes, priority, completion status, and URLs
- **Delete reminders** by ID
- **Get reminder by ID** - retrieve specific reminders
- **Get next upcoming reminder** - find the next scheduled reminder
- **List reminders** with flexible filtering:
  - Filter by due date range (due_after, due_before)
  - Filter by completion status (completed/incomplete)
  - Filter by priority level
  - Filter by calendar/list
- **Search reminders** - find reminders by text in title or notes

### Calendar Management
- **List all calendars** - view all available reminder lists
- **Get calendar by name** - retrieve calendar by its name
- **Get calendar by ID** - retrieve calendar by its identifier
- **Search calendars** - find calendars matching a query
- **Get default calendar** - access the default reminder list
- **Create reminders in specific calendars** - target specific lists when creating reminders

### Priority Support
- Four semantic priority levels: NONE, LOW, MEDIUM, HIGH
- Underlying support for fine-grained priority values (0-9)
- Filter reminders by priority
- Set priority when creating or updating reminders

### Event Callbacks
- **on_reminder_created** - register callbacks triggered when reminders are created

### Reminder Attributes
- Title
- Due date with time
- Notes
- Priority (0-9 or enum values)
- Completion status
- URLs
- Flagged status
- Created and modified timestamps
- Associated calendar/list ID

## Installation

```shell
python3 -m pip install git+https://github.com/namuan/pyremindkit
```

## Quick Start

### Basic Usage

```python
from datetime import datetime, timedelta

from pyremindkit import Priority
from pyremindkit import RemindKit

remind = RemindKit()

# Get the default calendar
default_calendar = remind.calendars.get_default()
print(f"Default calendar: {default_calendar.name}")

# List reminders due today or in the past that are incomplete
print("Incomplete reminders due today or in the past:")
for r in remind.get_reminders(due_before=datetime.now(), is_completed=False):
    print(f"- {r.title} (ID: {r.id}, Due: {r.due_date})")

# Create a new reminder
new_reminder = remind.create_reminder(
    title="Buy Milk",
    due_date=datetime.now(),
    notes="Get some oat milk too!",
    priority=Priority.HIGH,
    calendar_id=default_calendar.id,
)
print(f"Created reminder: {new_reminder.title} (ID: {new_reminder.id})")

# Move the reminder's due date 2 hours into the future
moved_reminder = remind.update_reminder(
    new_reminder.id,
    due_date=datetime.now() + timedelta(hours=2),
)
print(f"Moved reminder due date to: {moved_reminder.due_date}")

# Update the reminder's title
updated_reminder = remind.update_reminder(
    new_reminder.id,
    title="Buy Almond Milk Instead",
    notes="Changed my mind, get almond milk!",
)
print(f"Updated reminder title to: {updated_reminder.title}")
print(f"Updated reminder notes to: {updated_reminder.notes}")

# Get a reminder by ID
retrieved_reminder = remind.get_reminder_by_id(new_reminder.id)
print(f"Retrieved reminder: {retrieved_reminder.title}")

# Check for the next upcoming reminder
next_reminder = remind.get_next_reminder()
print(f"Next upcoming reminder: {next_reminder.title if next_reminder else 'None'}")

# Delete the reminder
remind.delete_reminder(new_reminder.id)
print(f"Deleted reminder: {new_reminder.title}")

# Verify the reminder was deleted
try:
    remind.get_reminder_by_id(new_reminder.id)
    print("Error: Reminder still exists!")
except ValueError:
    print("Verified: Reminder was successfully deleted")
```

## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.

### Fork the repository
* Create your feature branch (git checkout -b feature/AmazingFeature)
* Commit your changes (git commit -m 'Add some AmazingFeature')
* Push to the branch (git push origin feature/AmazingFeature)
* Open a Pull Request

## Development Setup

```shell
# Clone the repository
git clone https://github.com/namuan/pyremindkit.git
cd pyremindkit

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install development dependencies
pip install -r requirements/requirements-dev.txt
```

## License
This project is licensed under the MIT License - see the LICENSE file for details.

## Support
If you encounter any problems or have suggestions, please open an issue.

pyremindkit

pyremindkit Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

pyremindkit

pyremindkit Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README