The github API for Haskell
Switch branches/tags
Nothing to show
Pull request Compare This branch is 530 commits behind phadej:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Github
samples
.gitignore
LICENSE
NEWS.md
README.md
Setup.hs
github.cabal

README.md

Github

The Github API v3 for Haskell.

This is currently a read-only API.

Some functions which do not require authentication are also 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. Later.

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

Copyright

Copyright 2011, 2012 Mike Burns.

Available under the BSD 3-clause license.