Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wangningkai/github-trending
:octocat: GitHub Trending API power by Python Sanic.
https://github.com/wangningkai/github-trending
github github-api python sanic-framework
Last synced: 4 days ago
JSON representation
:octocat: GitHub Trending API power by Python Sanic.
- Host: GitHub
- URL: https://github.com/wangningkai/github-trending
- Owner: WangNingkai
- License: mit
- Created: 2020-08-11T07:28:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-08-12T07:55:16.000Z (over 4 years ago)
- Last Synced: 2024-10-11T11:11:10.401Z (about 1 month ago)
- Topics: github, github-api, python, sanic-framework
- Language: Python
- Homepage: https://github-trending.vercel.app
- Size: 6.84 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## GitHub Trending
> This project is a GitHub trending API power by Sanic.
> It was deployed on Vercel.
***
### Get Started
#### Get the trending repository
request address like this:
> /repo
+ If the language contains '#',you must use '-shuo' to replace it.
##### Parameters
| Name | Type | Description |
| ----- | ------ | ------------------------------------------------------------------------- |
| lang | string | optional, get method parameter, the language of trending repository |
| since | string | optional，get method parameter，default is daily,others is weekly,monthly |
For example request this address:
https://github-trending.vercel.app/repo?lang=java&since=weekly
return:
```
//status code: 201
{
"count": 25,
"msg": "suc",
//trending repositories
"items": [
{
//the avatar link of contributors
"avatars": [
"https://avatars0.githubusercontent.com/u/16903644?v=3&s=40",
"https://avatars2.githubusercontent.com/u/8622362?v=3&s=40",
"https://avatars0.githubusercontent.com/u/10773353?v=3&s=40",
"https://avatars3.githubusercontent.com/u/6392550?v=3&s=40",
"https://avatars1.githubusercontent.com/u/3837836?v=3&s=40"
],
//repository link
"repo_link": "https://github.com/kdn251/interviews",
//repository desctiption
"desc": "Everything you need to know to get the job.",
//repository name
"repo": "kdn251/interviews",
//the repository stars count
"stars": "5,772",
//the repository forks count
"forks": "539",
//the language of repository
"lang": "Java",
//the repository stars count for tody or this week or this month
"added_stars": "4,591 stars this week"
},
.
.
.
]
}
```
#### Get the trending developers
request address like this:
> /developer
+ If the language contains '#',you must use '-shuo' to replace it.
##### Parameters
| Name | Type | Description |
| ----- | ------ | ------------------------------------------------------------------------------- |
| lang | string | optional, get method parameter, maybe it is the major language of the developer |
| since | string | optional，get method parameter，default is daily,others is weekly,monthly |
For example request this address:
https://github-trending.vercel.app/developer?lang=java&since=weekly
return：
```
//status code: 201
{
"count": 25,
"msg": "suc",
//the trending developers
"items": [
{
//the username in GitHub of this developer
"user": "google",
//the main page in GitHub of this developer
"user_link": "https://github.com/google",
//the full name of this developer
"full_name": "(Google)",
//the avatar url of the developer
"developer_avatar": "https://avatars1.githubusercontent.com/u/1342004?v=3&s=96"
},
]
}
```
### Exception
If the server does not get the resources,the response will be that:
```
//status code: 404
{
"msg": "Unavailable.",
"count":0,
"items": []
}
```
### Maintenance
If some of the interface can not be used,please contact me with email:`[email protected]`,I will modify the problem as soon as possible,thank you!