Skip to main content

Weirnote Python SDK

Create, edit, and sync Weirnote libraries from Python. The SDK supports macOS 14 or later on Apple Silicon and Intel, with Python 3.11 or later. It bundles the Rust core and DoltLite engine in a platform-specific wheel.

See the Python API reference for the supported operations.

Build

Install Xcode 26.6 or later, Rust 1.98.1, and Python 3.11 or later. From the repository root, run:

python3 -m venv .venv
.venv/bin/python -m pip install wheel
.venv/bin/python scripts/build-wheel.py

The script creates a wheel for the Rust host architecture in dist/. It compiles DoltLite and generates the Python bindings against the exact native library included in the wheel. The build downloads the pinned crates from crates.io when needed. It also compiles the Swift sign-in helper and bundles it with an ad-hoc signature. See the release build instructions for Developer ID signing and notarization.

Use

Install the published package with pip install weirnote or add it to a uv project with uv add weirnote. To try a local build, install the matching wheel in a Python environment:

.venv/bin/python -m pip install dist/weirnote-*.whl

The following example creates an independent local library:

from weirnote import Note, open_library

with open_library("example.doltlite", create=True) as library:
    note = library.save_note(Note.from_text("First note from Python"))
    library.commit("Add example note")
    print(library.get_note(note.id).plain_text)

Apple sign-in and sync use the bundled Weirnote Python Account helper. The SDK sets it up automatically.

Test the wheel

bash scripts/test-wheel.sh dist/weirnote-*.whl
INSTALLER=uv bash scripts/test-wheel.sh dist/weirnote-*.whl

The tests install the wheel into a fresh virtual environment and exercise a synthetic database outside the checkout.

Native source

See DoltLite source provenance and licenses.

License

Weirnote’s SDK code is available under the Apache License, Version 2.0. See the icon notice for the artwork and marks. The DoltLite and SQLite terms and Rust dependency notices accompany every wheel.

Metadata

Release files for weirnote 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for weirnote 0.1.0
File Interpreter ABI Platform Actions
weirnote-0.1.0-py3-none-macosx_14_0_x86_64.whl Python 3 none macOS 14.0+ x86-64 Details for weirnote-0.1.0-py3-none-macosx_14_0_x86_64.whl
weirnote-0.1.0-py3-none-macosx_14_0_arm64.whl Python 3 none macOS 14.0+ ARM64 Details for weirnote-0.1.0-py3-none-macosx_14_0_arm64.whl

Total release size: 5.9 MB

Release files / weirnote-0.1.0-py3-none-macosx_14_0_x86_64.whl

Download URL weirnote-0.1.0-py3-none-macosx_14_0_x86_64.whl
Size 3.1 MB
Tags Python 3 macOS 14.0+ x86-64
SHA-256 checksum
How to use checksums
9438ebf6d9f7bbfe5ff07172be888e808c0c068840c55be73da87817fcef97c1
BLAKE2b-256 checksum
How to use checksums
78675650fb500420c111ebdf0d1a1f42825929ca1ca2e83ed8aa70a6eddd58ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.10

Release files / weirnote-0.1.0-py3-none-macosx_14_0_arm64.whl

Download URL weirnote-0.1.0-py3-none-macosx_14_0_arm64.whl
Size 2.8 MB
Tags Python 3 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
a4d26832ded1a250234f137ab1f2b330cc3d4b81e45f566194ebb36852ae43ba
BLAKE2b-256 checksum
How to use checksums
836343c5fdb4c109ff2c51aff38b188b12c5b14ee07a78be5ce1ef87b1fd0fb8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.10

Security for weirnote 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page