https://github.com/kevinapps/githubstar
Export Github stars and starred repos to HTML, bookmark, json or markdown format, grouped by language or topics, order by time, stargazers count etc..
https://github.com/kevinapps/githubstar
github python
Last synced: 3 months ago
JSON representation
Export Github stars and starred repos to HTML, bookmark, json or markdown format, grouped by language or topics, order by time, stargazers count etc..
- Host: GitHub
- URL: https://github.com/kevinapps/githubstar
- Owner: avalogic
- License: mit
- Created: 2023-09-08T09:47:59.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T00:29:26.000Z (over 1 year ago)
- Last Synced: 2025-01-16T13:43:45.294Z (about 1 year ago)
- Topics: github, python
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# githubstar
Export GitHub starred repositories, lists and topics to HTML, JSON, Markdown, or bookmark, grouped by language or topic, ordered by time, stargazer count etc.
## Installation
- Using [pip](https://pypi.org/project/githubstar/)
```
$ pip install githubstar
```
- Using Binaries (x64 architecture only) from [Release page](https://github.com/kevinapps/githubstar/releases)
- You can also clone the repo and build from source
## Quick Start
Run with a username
```
$ githubstar --username
```
Run with username, GitHub access token, and default options
```
$ export GITHUB_TOKEN=
$ githubstar --username
```
or
```
$ githubstar --username --token
```
Export to json format
```
$ githubstar --username --token --format json
```
Run with language grouping and bookmark format
```
$ githubstar --username --token --format bookmark --groupby language
```
## Usage
```
$ githubstar -h
usage: githubstar [-h] [--version] --username USERNAME [--token TOKEN] [--format {html,json,md,bookmark}]
[--groupby {none,language,topic}]
[--orderby {timestarred,timeupdated,alphabet,starscount,forkscount,language}]
[--orderdirection {desc,asc}] [--ordernum {true,false}] [--excludeprivate {true,false}]
[--destpath DESTPATH] [--destname DESTNAME]
Export a GitHub user's starred list to local file.
options:
-h, --help show this help message and exit
--version show the program's version number and exit
--username USERNAME [required]username to export for
--token TOKEN the token from https://github.com/settings/tokens, to avoid rate limiting, can also store in
environment as 'GITHUB_TOKEN'.
--format {html,json,md,bookmark}
output format, default: html
--groupby {none,language,topic}
default: none
--orderby {timestarred,timeupdated,reponame,starscount,forkscount,language}
default: timestarred
--orderdirection {desc,asc}
default: desc
--ordernum {true,false}
choose whether to display the order number before the repository name, default: true
--excludeprivate {true,false}
exclude private repositories, default: false
--destpath DESTPATH path to store the exported file
--destname DESTNAME filename of the exported file
```
## FAQ
- What does 'RateLimitExceededException' mean?
The GitHub API rate limiting has been reached. An access token is needed in this case. Check out this link [https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting](https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting) for more details.
- Where to get the access token?
Log in with your GitHub account and go to the following pages to generate an access token. Either a fine-grained token or a classic token is acceptable.
- [https://github.com/settings/personal-access-tokens](https://github.com/settings/personal-access-tokens)
- [https://github.com/settings/tokens](https://github.com/settings/tokens)