GitHub API Bindings for Pharo

Code status
Docs status

This project provides bindings to the GitHub API for Pharo. In particular, the aim is to provide bindings using Object-Oriented design principles.

Installation

To install into Pharo, evaluate the following Metacello script in your Pharo 5 image: 

Metacello new
	baseline: 'GitHub';
	repository: 'github://Balletie/GitHub:master';
	load.

Replace the master part with any version tag to load that specific version.

To load everything (including the tool and tests), evaluate this script: 

Metacello new
	baseline: 'GitHub';
	repository: 'github://Balletie/GitHub:master';
	load: #(tool tests).

Replace #(tool tests) with one of the other options:

#tool
Loads just the tool (this does not load the Issues and Pull Requests API, for example).
#tests
Loads all of the bindings and the tests, but not the tool.
#(tool default)
Loads the tool and all of the bindings, but not the tests.

Documentation

Documentation can be found on this website, in two formats:

The documentation was generated with the Pillar markup language. The source of this documentation can be found under the docs branch in the source code repository.

Source code repository

The code is hosted on GitHub, at Balletie/GitHub.

License

This project is released under the MIT License. See the LICENSE file in the source repository for details.