The github package

[Tags: bsd3, library]

The Github API provides programmatic access to the full Github Web site, from Issues to Gists to repos down to the underlying git data like references and trees. This library wraps all of that, exposing a basic but Haskell-friendly set of functions and data structures.

For more of an overview please see the README:

[Skip to ReadMe]


Versions0.1, 0.1.1, 0.1.2, 0.2.0, 0.2.1, 0.3.0, 0.4.0, 0.4.1, 0.5.0, 0.6.0, 0.7.0, 0.7.1, 0.7.2, 0.7.3, 0.7.4, 0.8, 0.9, 0.10.0, 0.11.0, 0.11.1, 0.12, 0.13, 0.13.1, 0.13.2
Change logNone available
Dependenciesaeson (>=, attoparsec (>=, base (>=4.0 && <5.0), base16-bytestring (>=, byteable (>=0.1.0), bytestring, case-insensitive (>=, conduit, containers, cryptohash (>=0.11), data-default, failure, hashable, HTTP, http-conduit (>=1.8), http-types, network, old-locale, text, time, unordered-containers (==0.2.*), vector [details]
CopyrightCopyright 2012-2013 Mike Burns, Copyright 2013-2015 John Wiegley
AuthorMike Burns, John Wiegley
CategoryNetwork APIs
Home page
Source repositoryhead: git clone git://
UploadedSun Apr 26 19:58:46 UTC 2015 by JohnWiegley
DistributionsDebian:0.13.2, NixOS:0.13.2
Downloads4913 total (244 in last 30 days)
0 []
StatusDocs available [build log]
Last success reported on 2015-04-26 [all 1 reports]




Maintainers' corner

For package maintainers and hackage trustees

Readme for github-0.13.2


The Github API v3 for Haskell.

Some functions are missing; these are functions where the Github API did not work as expected. The full Github API is in beta and constantly improving.


In your project's cabal file:

-- Packages needed in order to build this package.
Build-depends:       github

Or from the command line:

cabal install github

Example Usage

See the samples in the samples/ directory.


For details see the reference documentation on Hackage.

Each module lines up with the hierarchy of documentation from the Github API.

Each function has a sample written for it.

All functions produce an IO (Either Error a), where a is the actual thing you want. You must call the function using IO goodness, then dispatch on the possible error message. Here's an example from the samples:

import qualified Github.Users.Followers as Github
import Data.List (intercalate)

main = do
  possibleUsers <- Github.usersFollowing "mike-burns"
  putStrLn $ either (("Error: "++) . show)
                    (intercalate "\n" . map formatUser)

formatUser = Github.githubOwnerLogin


Please see for details on how you can help.


Copyright 2011, 2012 Mike Burns. Copyright 2013-2014 John Wiegley.

Available under the BSD 3-clause license.