https://github.com/vaibhavsagar/duffer

A git-compatible content tracker in Haskell.
https://github.com/vaibhavsagar/duffer

git haskell

Last synced: 8 months ago
JSON representation

A git-compatible content tracker in Haskell.

• Host: GitHub
• URL: https://github.com/vaibhavsagar/duffer
• Owner: vaibhavsagar
• Created: 2016-03-05T17:00:34.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-01-10T19:03:52.000Z (almost 6 years ago)
• Last Synced: 2025-03-17T22:54:41.484Z (8 months ago)
• Topics: git, haskell
• Language: Haskell
• Homepage: http://vaibhavsagar.com/duffer
• Size: 2.08 MB
• Stars: 67
• Watchers: 6
• Forks: 4
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
duffer

=========

[![Build Status](https://travis-ci.org/vaibhavsagar/duffer.svg?branch=master)](https://travis-ci.org/vaibhavsagar/duffer)

[![made at Recurse Center](https://cdn.rawgit.com/heatherbooker/made_at_rc/master/made_at_RC.svg)](https://www.recurse.com)

This is a learning exercise and an API for `git`, in that order. Please do not

use this code in production. Instead I would recommend Vincent Hanquez's

excellent and very educational [hs-git](https://github.com/vincenthz/hs-git/).

I [gave a presentation](https://www.youtube.com/watch?v=wsNnP3we_R4) on this

project.

# What this library does

- Reads and writes loose blobs, trees, commits, and tags.

- Reads full packfiles.

- Reads and writes git refs.

# Some things this library does not do (yet)

- Generate a packfile index from a packfile.

- Support arbitrary backends besides file storage.

- Read .git/index

- Diffs (you can get surprisingly far without them!)

- Provide Functor, Applicative, or Monad instances for a repository, whatever that means.

# Goals

Although this is primarily a way for me to learn both Haskell and `git` at the

same time, there a couple of (I think) cool things I would like to do with this

library:

- Use `git` as a NoSQL store, i.e. using `git` data formats to persist data for

  an application. [Irmin](https://github.com/mirage/irmin) is exactly this for

  OCaml but I don't know of an equivalent in Haskell (although

  [filestore](https://hackage.haskell.org/package/filestore) comes close). This

  means eventually supporting pluggable backends like Irmin and `libgit2` do so

  that you're not limited to a filesystem backend.

- A GraphQL/other query language interface to a `git` repository's commits. If

  commits form a beautiful acyclic directed graph, there has to be a better way

  of querying them than `git log`.

# Getting Started

1. [Set up `stack`](https://docs.haskellstack.org/en/stable/README/) if you

   haven't already.

2. Clone this repository: `git clone git@github.com:vaibhavsagar/duffer.git`

3. `cd duffer`

4. `stack test`

5. Tests should all pass. If they don't, please open an issue.