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.0.tar.gz (68.5 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.0-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: notesctl-1.0.0.tar.gz
  • Upload date:
  • Size: 68.5 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.0.tar.gz
Algorithm Hash digest
SHA256 83ad996cc5928e8d4787f63b5872c97164a402194b093c71a09bc9a1172df9ca
MD5 b8f50269a605fd6bfd6d0455cc602229
BLAKE2b-256 a4738c2deec6eaa3385b9ebb15452c20c7e098019e4a062c6ab02ba5e87d3b4d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: notesctl-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 24.6 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51074b28af457eadc3ded2be7cf6f95d1e33e0945847faff73929831d474ac1f
MD5 819f734b1e31c18d7edad2ffbd82825d
BLAKE2b-256 1750b1169058ab4b32188b88d58173b6dbfb7eb842266081b344a8fb476a5a47

See more details on using hashes here.

Provenance

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