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.3.tar.gz (64.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.3-py3-none-any.whl (25.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for notesctl-1.0.3.tar.gz
Algorithm Hash digest
SHA256 28cb12c7c0d2551a44d524f66712c1ccfc9617410f0fb7711c5a1dbb1db16ef3
MD5 cb2261c3997ab7e438077ac9599a5591
BLAKE2b-256 3ffd6b8b08f24b4d1c4a77deb1c20e64889d75355c664fb3d6d4079ca95e331b

See more details on using hashes here.

Provenance

The following attestation bundles were made for notesctl-1.0.3.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.3-py3-none-any.whl.

File metadata

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

File hashes

Hashes for notesctl-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6b39d649e4d9de7da55be1a0af708b5d474f23af061b8cdfd2a09255912e4fa4
MD5 ac9b4730bf3688b89c9cea593e07d19c
BLAKE2b-256 a57e92bba8a50df51b9b445d062d0cfd02a700608c565ad59b44712bdcf1a351

See more details on using hashes here.

Provenance

The following attestation bundles were made for notesctl-1.0.3-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