Skip to main content

Generic key-value interface to a Git repository

Project description

Build Status Code Coverage

A Git-based key-value store backend for Indicium.

Usage

# Instantiate and write some data.
from indicium.git import GitStore
store = GitStore("./data", autocommit=False)
store.put("/the-answer", b"10")

# Not needed with autocommit=True
store.commit("Note down the answer to everything")

# Create a new commit with the correct answer.
store.put("/the-answer", b"42")
store.commit("Fix the answer to everything")

The ./data directory will contain a Git repository which can be inspected with git. Every call to .commit() adds a commit to it or, with the auto-commit mode enabled, every call to .put() and .delete() will implicitly add a commit.

Installation

All stable releases are uploaded to PyPI, so you can install them and upgrade using pip:

pip install indicium-git

Alternatively, you can install the latest development code —at your own risk— directly from the Git repository:

pip install git://github.com/aperezdc/indicium-git

Development

If you want to contribute, please use the usual GitHub workflow:

  1. Clone the repository.

  2. Hack on your clone.

  3. Send a pull request for review.

If you do not have programming skills, you can still contribute by reporting issues that you may encounter. Contributions to the documentation are very welcome, too!

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

indicium-git-0.1.0a0.tar.gz (3.0 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page