Skip to main content

Git-free marimo notebook sharing via GitHub

Project description

⚓ mooring

Git-free marimo notebook sharing via GitHub.

Mooring is a single-file app (mooring.pyz / mooring.exe) that lets a team of data analysts pull, edit, and push marimo notebooks stored in a shared GitHub repo — without git installed on their machines. All sync happens over the GitHub REST API; the only requirement on an analyst's machine is Python 3.12.

Double-clicking the app opens a local browser hub: log in to GitHub with a one-time device code, see every team notebook with its sync status, pull the latest, open notebooks in the bundled marimo editor, and push your changes back — one commit per file, with conflicts detected and resolved per file (never silently overwritten).

How it works

  • One shared team repo (e.g. your-org/notebooks) holds notebooks/, data/, and reports/ folders. Everyone pulls from and pushes to it.
  • No git anywhere. Pull walks the repo tree via the GitHub Git Data API and downloads only changed blobs; push uses the Contents API with the file's last-known SHA, so GitHub itself rejects writes that would clobber someone else's change.
  • Conflicts are explicit. Pull never overwrites local edits; push blocks conflicted files, offering per-file resolution.
  • Push or propose. Push commits straight to the shared branch; propose sends changes to a personal review branch so they can land via a pull request — protect the branch and propose becomes the only way in.
  • Frozen package stack. Notebooks can import anything bundled into the artifact (polars, altair, plotly, openpyxl, fastexcel, requests, plus the standard library). There is no pip at runtime.
  • Works on corporate GitHub. GitHub Enterprise instances are supported (mooring login --host ghe.example.com), and TLS is verified against the OS trust store, so SSL-intercepting proxies with an IT-installed root CA just work.

Documentation

Full docs live in docs/ and build into a searchable site with zensical:

Build & preview the docs

uv sync
uv run zensical serve     # live-reloading preview at a local URL
uv run zensical build     # static site into ./site

.github/workflows/docs.yml publishes the site to GitHub Pages on every push to the default branch.

Develop

uv sync                                  # install everything
uv run pytest                            # unit tests (no network needed)
uv run ruff check src tests              # lint
uv run mooring hub                       # run the hub from source

See contributing for the architecture, integration testing, and project conventions.


Built with moonlit.

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

mooring-0.2.5.tar.gz (125.4 kB view details)

Uploaded Source

Built Distribution

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

mooring-0.2.5-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

Details for the file mooring-0.2.5.tar.gz.

File metadata

  • Download URL: mooring-0.2.5.tar.gz
  • Upload date:
  • Size: 125.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mooring-0.2.5.tar.gz
Algorithm Hash digest
SHA256 5da2cfd1d25fea227a3e4b5de8daacb84c0c8cfd044c7cd3f7d35fc78b000b8e
MD5 49e6dd1820f87d2957355ea2dfda644f
BLAKE2b-256 4ce70afe78a5900d780812227fe9f2372ca5f97cc51598a538cf29aa07ec928c

See more details on using hashes here.

File details

Details for the file mooring-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: mooring-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 48.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mooring-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0a7c4bfbb383bff56497acac0b18a96df5af0e4214f5cafedd2a295d826f7ed2
MD5 554908ff14c1a379c167baac40471031
BLAKE2b-256 2604ec67aabe73663413e04d228fa8345f011dc46080fbdda1486f0e392e6a91

See more details on using hashes here.

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