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. Currently this only supports read-only access. For more of an overview please see the README: https://github.com/mike-burns/github/blob/master/README.md


[Skip to ReadMe]

Properties

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 (==0.5.0.0), attoparsec (==0.10.1.0), base (>=4.0 && <5.0), bytestring, containers, failure, HTTP, http-enumerator (==0.7.2.1), http-types, network, old-locale, text, time, unordered-containers (==0.1.4.3), uri, vector [details]
LicenseBSD3
CopyrightCopyright 2011 Mike Burns
AuthorMike Burns
Maintainermike@mike-burns.com
CategoryNetwork APIs
Home pagehttps://github.com/mike-burns/github
Source repositoryhead: git clone git://github.com/mike-burns/github.git
UploadedWed Dec 28 18:32:31 UTC 2011 by MikeBurns
DistributionsDebian:0.13.2, NixOS:0.13.2
Downloads4633 total (224 in last 30 days)
Votes
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for github-0.1.2

Github

The Github API v3 for Haskell.

This is currently a read-only API. There is a read-write branch with ideas on how this can work for writing to Github, but I need ideas on how authentication should work. You can help if you let me know how you are using this library or how you would like to use it, and which authentication method is best for you (HTTP basic, OAuth).

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 Mike Burns.

Available under the BSD 3-clause license.