The github package

[Tags:bsd3, library, test]

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: https://github.com/fpco/github/blob/master/README.md


[Skip to Readme]

Properties

Versions 0.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, 0.14.0, 0.14.1, 0.15.0
Dependencies aeson (>=0.6.1.0), attoparsec (>=0.10.3.0), base (>=4.0 && <5.0), bytestring, case-insensitive (>=0.4.0.4), conduit, containers, data-default, failure, hashable, HTTP, http-conduit (>=1.8), http-types, network, old-locale, text, time, unordered-containers (==0.2.*), vector [details]
License BSD3
Copyright Copyright 2012-2013 Mike Burns, Copyright 2013 John Wiegley
Author Mike Burns, John Wiegley
Maintainer johnw@fpcomplete.com
Stability Unknown
Category Network APIs
Home page https://github.com/fpco/github
Source repository head: git clone git://github.com/fpco/github.git
Uploaded Fri May 2 17:38:02 UTC 2014 by JohnWiegley
Distributions Debian:0.13.2, NixOS:0.15.0, Stackage:0.15.0
Downloads 6399 total (107 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Successful builds reported [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for github

Readme for github-0.8

Github

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.

Installation

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.

Documentation

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 Github.Users.Followers
import Data.List (intercalate)
main = do
  possibleUsers <- usersFollowing "mike-burns"
  putStrLn $ either (\error -> "Error: " ++ $ show error)
                    (intercalate "\n" . map githubUserLogin)
                    possibleUsers

Contributions

Please see CONTRIBUTING.md for details on how you can help.

Copyright

Copyright 2011, 2012 Mike Burns.

Available under the BSD 3-clause license.