Skip to main content

Export Apple iCloud Notes to Markdown files safely

Project description

notesctl

Export Apple iCloud Notes to Markdown files safely.

Features

  • Safe: Copies database before reading, uses read-only mode
  • Complete: Exports text, formatting, and attachments
  • Organized: Groups notes by folder with YAML frontmatter

Installation

# Using uv (recommended)
uv pip install .

# Or install in development mode
uv pip install -e ".[dev]"

Usage

# Export all notes
uv run notesctl export -o ~/notes-backup

# Export specific folder
uv run notesctl export --folder "Work" -o ~/work-notes

# Preview without writing (safe)
uv run notesctl export --dry-run

# List notes
uv run notesctl list-notes

# List folders
uv run notesctl list-folders

# Show statistics
uv run notesctl stats

Safety

This tool prioritizes safety:

  1. Copy-first: Database files are copied to temp directory before reading
  2. Read-only: SQLite connection uses URI mode=ro
  3. SELECT only: All queries are validated to be SELECT statements
  4. Dry-run mode: Preview exports without writing files

Development

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

# Run tests
uv run pytest

# Run linter
uv run ruff check src tests

# Run type checker
uv run mypy src

# Format code
uv run ruff format src tests

Requirements

  • macOS with Apple Notes
  • Python 3.11+
  • uv (recommended) or pip

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

notesctl-1.0.1.tar.gz (68.8 kB view details)

Uploaded Source

Built Distribution

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

notesctl-1.0.1-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file notesctl-1.0.1.tar.gz.

File metadata

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

File hashes

Hashes for notesctl-1.0.1.tar.gz
Algorithm Hash digest
SHA256 f5b91f47d36750d81e78d1957100a07d01a9dfa9c705bb99e031005bc136386d
MD5 507ee8cc87f27e1afda4f3db2ed8ee81
BLAKE2b-256 fce98fb68e2be06ce2e3ff48acdd940092f628d322ea3f918781aba344d01575

See more details on using hashes here.

Provenance

The following attestation bundles were made for notesctl-1.0.1.tar.gz:

Publisher: publish.yml on jwmoss/notesctl

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

File details

Details for the file notesctl-1.0.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for notesctl-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0af4de738f678ffd3708e1ce4927a840d0d755297c01fb15acc6a8d6d563bcb6
MD5 5b0b431e5ee713b8952ca89344224d6c
BLAKE2b-256 7d70b7f119a8b200bca30398e1548f03125445da5a39a9106c218b396d047214

See more details on using hashes here.

Provenance

The following attestation bundles were made for notesctl-1.0.1-py3-none-any.whl:

Publisher: publish.yml on jwmoss/notesctl

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