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
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.
Request functions (ending with R
) construct a data type with can be executed
in IO
by executeRequest
functions. They are all listed in the root GitHub
module.
IO 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:
Many function have samples under
samples/
directory.
import qualified GitHub.Endpoints.Users.Followers as Github
main = do
possibleUsers <- GitHub.usersFollowing "mike-burns"
T.putStrLn $ either (("Error: " <>) . T.pack . show)
(foldMap (formatUser . (<> "\n")))
possibleUsers
formatUser = GitHub.untagName . GitHub.githubOwnerLogin
To run integration part of tests, you'll need github access token Token is needed, because unauthorised access is highly limited. It's enough to add only basic read access for public information.
With travis encrypt --org --repo yournick/github "GITHUB_TOKEN=yourtoken"
command you get a secret,
you can use in your travis setup to run the test-suite there.
Please see CONTRIBUTING.md for details on how you can help.
Copyright 2011-2012 Mike Burns. Copyright 2013-2015 John Wiegley. Copyright 2016 Oleg Grenrus.
Available under the BSD 3-clause license.