https://github.com/pveyes/octopub
GitHub public data as a service
https://github.com/pveyes/octopub
github lambda now profile rust scraper serverless
Last synced: 5 months ago
JSON representation
GitHub public data as a service
- Host: GitHub
- URL: https://github.com/pveyes/octopub
- Owner: pveyes
- Created: 2019-05-06T13:27:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-21T22:11:47.000Z (over 2 years ago)
- Last Synced: 2025-02-02T01:01:49.330Z (12 months ago)
- Topics: github, lambda, now, profile, rust, scraper, serverless
- Language: Rust
- Homepage: https://octopub.now.sh
- Size: 130 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# octopub
> GitHub public data as a service
## Usage
This service provides easy way to retrieve 2 public data from GitHub without creating access token:
### Get public profile
Send GET request to `https://octopub.now.sh/profile/:username`
Example:
```sh
curl -H "Accept: application/json" https://octopub.now.sh/profile/pveyes
```
Response type:
```ts
type PublicProfileResponse = {
username: string
name?: string
bio?: string
site?: string
}
```
### Get public repository data
Send GET request to `https://octopub.now.sh/repo/:owner/:repo`
Example:
```sh
curl -H "Accept: application/json" https://octopub.now.sh/repo/pveyes/octopub
```
Response type:
```ts
type PublicRepoResponse = {
description: string
link?: string
watchCount: number
starCount: number
forkCount: number
}
```
## Limitation
- Data retrieved using this service won't be as complete as GitHub API
- Providing same result with GitHub API is non goal
## License
MIT