Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/astares/github-api
GitHub API Wrapper for Pharo
https://github.com/astares/github-api
pharo
Last synced: 26 days ago
JSON representation
GitHub API Wrapper for Pharo
- Host: GitHub
- URL: https://github.com/astares/github-api
- Owner: astares
- Created: 2016-09-14T20:19:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-27T13:53:48.000Z (about 7 years ago)
- Last Synced: 2024-10-31T06:41:48.889Z (2 months ago)
- Topics: pharo
- Language: Smalltalk
- Size: 24.4 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GitHub-API (for Pharo)
## Important note:
there meanwhile are three wrappers available:
1. https://balletie.github.io/GitHub/ (from Balletie, very complete)
2. https://github.com/astares/GitHub-API (this one)
3. https://github.com/guillep/github-api (one from Guille, who now bases on the one from Balletie)
## Introduction
This project is a **GitHub API Wrapper** for [Pharo](http://www.pharo.rog) to easily access informations from GitHub right from your Pharo image.
### Loading the project
You can load the **GitHub-API Wrapper** easily into your Pharo image by using the follwing load expression:
```Smalltalk
Metacello new
repository: 'github://astares/GitHub-API/repository';
baseline: 'GitHubAPI';
load.
```
## Usage
### Accessing GitHub users
You can access GitHub users in two ways, either using the class **GitHubUser**
```Smalltalk
GitHubUser named: 'astares'
```
or by asking the **GitHub** class:
```Smalltalk
GitHub userNamed: 'astares'
```
### Working with a GitHub user
#### Retrieving the Avatar
If you have a user you can easily access the Avatar as a regular **Form** instance in Pharo:
```Smalltalk
(GitHub userNamed: 'astares') avatar
```
returning the following graphic form/picture:
#### Check the user type
You can check if the user is an organization or regular user:
```Smalltalk
(GitHub userNamed: 'pharo-project') isOrganization
```
which in the particular case of our example returns **true** as the [Pharo-project organization has an account on GitHub](https://github.com/pharo-project).
### Working with a GitHub repositories of a user
To access the collection of repositories for a given GitHub user you can use one of the two expressions:
```Smalltalk
(GitHubUser named: 'pharo-project') repositories
```
or
```Smalltalk
GitHub repositoriesForUser: 'pharo-project'
```
which is a little bit shorter.
## Project Structure
### General packages
Package name | Description
--------------- | ------------------
GitHub-API-Core | The core package
### Test packages
Package name | Description
----------------------- | ---------------------------
GitHub-API-Test-Core | Tests for the core package
## License
(c) 2016 by Dipl.-Inf. T.Bergmann, Astares
Code is released and published with **MIT License** when used for Pharo projects.