Skip to main content

A version control system for office documents

Project description

Matter2

A version control system for office documents.

PyPI - Version

What is Matter?

Matter is a VCS designed for office documents (DOCX, PPTX, PDF, etc.) rather than source code. It provides:

  • ZIP-aware storage — Office formats are unpacked and stored efficiently. A one-word edit to a DOCX doesn't duplicate the entire file.
  • Document identity tracking — Rename a file and Matter knows it's the same document.
  • Branch and merge — Branch document collections for review cycles. Conflicts are surfaced as side-by-side files for manual resolution.
  • Portable format — Export a repository as a self-contained archive.

Installation

pip install matter2

With optional diff support (DOCX/PDF text extraction):

pip install matter2[diff]

Quick Start

# Initialize a repository
matter init

# Add and commit documents
matter add contract.docx proposal.pdf
matter commit -m "Initial documents" -a user@example.com

# Check status
matter status

# View history
matter log

# Branch for review
matter branch client-review
matter switch client-review

# Merge back
matter switch main
matter merge client-review

# Track a document across renames
matter track contract.docx

# Export for sharing
matter export backup.tar.gz

Library Usage

from matter import Repository

repo = Repository.init("/path/to/repo")
repo.add(["contract.docx"])
cp = repo.commit(message="Add contract", author="user@example.com")
content = repo.restore(cp.id, "contract.docx")

Architecture

See design spec for the full architecture.

License

MIT

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

matter2-0.3.0.tar.gz (60.7 kB view details)

Uploaded Source

Built Distribution

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

matter2-0.3.0-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file matter2-0.3.0.tar.gz.

File metadata

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

File hashes

Hashes for matter2-0.3.0.tar.gz
Algorithm Hash digest
SHA256 87576deba03257eeb2150d6e9f535676732033211b0b3f97786f8ec967a97ba7
MD5 de446b5f81dc1b2ad8843e44ea2c8c31
BLAKE2b-256 0500816fb24fec4aada30c9bcb7eb87222abef4a48eff08bb7ed1fcde842c182

See more details on using hashes here.

Provenance

The following attestation bundles were made for matter2-0.3.0.tar.gz:

Publisher: publish.yml on JSv4/Matter2

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

File details

Details for the file matter2-0.3.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for matter2-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 48af5e61f316ade35dd7069ccb5c45e774542adad215e165a71a6c3a134ab325
MD5 608ce7427ebecbe6b50fa4e4d0f35d17
BLAKE2b-256 c7716c87b382979e57dea8ed597b2840b6f7e466ee09e9b117cdf5b9454aae93

See more details on using hashes here.

Provenance

The following attestation bundles were made for matter2-0.3.0-py3-none-any.whl:

Publisher: publish.yml on JSv4/Matter2

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