github
Access to the GitHub API, v3.
https://github.com/phadej/github
| Version on this page: | 0.27@rev:1 |
| LTS Haskell 22.41: | 0.29@rev:6 |
| Stackage Nightly 2024-11-12: | 0.29@rev:6 |
| Latest on Hackage: | 0.29@rev:6 |
github-0.27@sha256:2288b807a4bd97fefeff75487ef5d2ed31f0faa18f306e01e5f5cb498e228208,7033Module documentation for 0.27
- GitHub
- GitHub.Auth
- GitHub.Data
- GitHub.Data.Activities
- GitHub.Data.Comments
- GitHub.Data.Content
- GitHub.Data.Definitions
- GitHub.Data.DeployKeys
- GitHub.Data.Deployments
- GitHub.Data.Email
- GitHub.Data.Enterprise
- GitHub.Data.Events
- GitHub.Data.Gists
- GitHub.Data.GitData
- GitHub.Data.Id
- GitHub.Data.Invitation
- GitHub.Data.Issues
- GitHub.Data.Milestone
- GitHub.Data.Name
- GitHub.Data.Options
- GitHub.Data.PublicSSHKeys
- GitHub.Data.PullRequests
- GitHub.Data.RateLimit
- GitHub.Data.Releases
- GitHub.Data.Repos
- GitHub.Data.Request
- GitHub.Data.Reviews
- GitHub.Data.Search
- GitHub.Data.Statuses
- GitHub.Data.Teams
- GitHub.Data.URL
- GitHub.Data.Webhooks
- GitHub.Endpoints
- GitHub.Endpoints.Activity
- GitHub.Endpoints.Enterprise
- GitHub.Endpoints.Gists
- GitHub.Endpoints.GitData
- GitHub.Endpoints.Issues
- GitHub.Endpoints.Organizations
- GitHub.Endpoints.PullRequests
- GitHub.Endpoints.RateLimit
- GitHub.Endpoints.Repos
- GitHub.Endpoints.Repos.Collaborators
- GitHub.Endpoints.Repos.Comments
- GitHub.Endpoints.Repos.Commits
- GitHub.Endpoints.Repos.Contents
- GitHub.Endpoints.Repos.DeployKeys
- GitHub.Endpoints.Repos.Deployments
- GitHub.Endpoints.Repos.Forks
- GitHub.Endpoints.Repos.Invitations
- GitHub.Endpoints.Repos.Releases
- GitHub.Endpoints.Repos.Statuses
- GitHub.Endpoints.Repos.Webhooks
- GitHub.Endpoints.Search
- GitHub.Endpoints.Users
- GitHub.Enterprise
- GitHub.Internal
- GitHub.Request
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.
Note: some samples might be outdated.
Documentation
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 which 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.
{-# LANGUAGE NoImplicitPrelude #-}
{-# LANGUAGE OverloadedStrings #-}
import Prelude.Compat
import Data.Text (Text, pack)
import Data.Text.IO as T (putStrLn)
import Data.Monoid ((<>))
import GitHub (github')
import qualified GitHub
main :: IO ()
main = do
possibleUsers <- github' GitHub.usersFollowingR "phadej"
T.putStrLn $ either (("Error: " <>) . pack . show)
(foldMap ((<> "\n") . formatUser))
possibleUsers
formatUser :: GitHub.SimpleUser -> Text
formatUser = GitHub.untagName . GitHub.simpleUserLogin
Test setup
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.
Contributions
Please see CONTRIBUTING.md for details on how you can help.
Copyright
Copyright 2011-2012 Mike Burns. Copyright 2013-2015 John Wiegley. Copyright 2016-2019 Oleg Grenrus.
Available under the BSD 3-clause license.