Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leaking/gitknife
An Android library for Github API
https://github.com/leaking/gitknife
Last synced: 3 days ago
JSON representation
An Android library for Github API
- Host: GitHub
- URL: https://github.com/leaking/gitknife
- Owner: Leaking
- License: apache-2.0
- Created: 2015-08-17T02:45:38.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-08-17T09:02:54.000Z (over 9 years ago)
- Last Synced: 2024-10-11T20:11:10.032Z (about 1 month ago)
- Language: Java
- Homepage:
- Size: 254 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitKnife
An Android library for Github API,I have use it in [WeGit](https://github.com/Leaking/WeGit).
# About The Github API
You can read the API documents in [https://developer.github.com/v3/](https://developer.github.com/v3/).
# Rate Limiting
Without authorizations,the rate limiting is 60 per minute,With authorizations,the rate limiting is 5000 per minute.So you had better add token in your every request.
# Token
In the latest API,you can not get existing token,so if you want to get existing token you need to delete it and re-create it.
# How to use it
## Init
```java
Github github = new GithubImpl(context);
```
## Create Token
```java
String token = github.createToken(username,password);
```
## Get Login User
```java
User user = github.authUser(token);
```
## Get Certain User
```java
User user = github.user(username);
```
## Repositories
```java
repos = github.repo(user, page);
```
## Starred Repositories
```java
repos = github.starred(user, page);
```
## Followings
```java
users = github.follwerings(user, page);
```
## Your Followers
```java
users = github.followers(user, page);
```
## If you has followed someone
```java
github.makeAuthRequest(token);
boolean ifFollow = github.hasFollow(targetUser);
```
## Unfollow someone
```java
github.makeAuthRequest(token);
boolean success = github.unfollow(targetUser);
```
## Follow someone
```java
github.makeAuthRequest(token);
boolean success = github.follow(targetUser);
```
## If you has starred Repo X
```java
boolean hasStar = github.hasStarRepo(owner, repo);
```
## Star Repo X
```java
github.makeAuthRequest(token);
boolean success = github.starRepo(owner, repo);
```
## Unstar Repo X
```java
github.makeAuthRequest(token);
boolean success = github.unStarRepo(owner, repo);
## Received Event
```java
events = github.receivedEvent(user, page);
```
## Stargzers of Repo X
```java
users = github.stargazers(owner,repo,page);
```
## Forkers of Repo X
```java
users = github.forkers(owner,repo,page);
```
## Load content of Repo X
```java
Tree tree = github.getTree(owner, repo, sha);
```
## LICENSE
Copyright 2015 Quinn Chen
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.