Octokit

An Elixir library for accessing the GitHub API.

Like all versions of Octokit, this project does its best to conform to the community standards for the language it is written in and for. If there are places where this library does not conform, please file an Issue.

Installation

First, add Octokit to your mix.exs dependencies:

def deps do
  [ {:octokit, "~> 0.1.0"} ]
end

and run mix deps.get. Now, list the :octokit application as an application dependency:

def application do
  [applications: [:octokit]]
end

Development

This project follows the GitHub "scripts to rule them all" pattern. The contents of the scripts directory are scripts that cover all common tasks:

script/setup — Performs first-time setup
script/update — Performs periodic updating
script/test — Runs automated tests
script/console — Opens the development console

Other scripts that are available but not intended to be used directly by developers:

script/bootstrap — Used to do a one-time install of all prerequisites for a development machine
script/cibuild — Used to run automated tests in the CI environment

Testing

Mock API Responses

All mock API responses are stored in IEx inspect output for easy deserialization into native Elixir data structures. The format of the files in test/fixtures is:

Commented out HTTPoison.get! API call used to retrieve the response
Response object returned from the above API call

Test Helpers for Fixtures and Mocks