| Name | githubstar JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | Export Github starred repos list to file |
| upload_time | 2025-07-09 08:32:21 |
| maintainer | None |
| docs_url | None |
| author | avalogic@github |
| requires_python | >=3.13 |
| license | MIT License
Copyright (c) 2025 avalogic
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
github
star
stars
starred
export
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
PyGithub
requests
requests
beautifulsoup4
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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/avalogic/githubstar/releases)
- You can also clone the repo and build from source
## Quick Start
Run with a username
```
$ githubstar --username <username>
```
Run with username, GitHub access token, and default options
```
$ export GITHUB_TOKEN=<Access-Token>
$ githubstar --username <username>
```
or
```
$ githubstar --username <username> --token <Access-Token>
```
Export to json format
```
$ githubstar --username <username> --token <Access-Token> --format json
```
Run with language grouping and bookmark format
```
$ githubstar --username <username> --token <Access-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)
Raw data
{
"_id": null,
"home_page": null,
"name": "githubstar",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13",
"maintainer_email": null,
"keywords": "github, star, stars, starred, export",
"author": "avalogic@github",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e5/65/84be19b4dd451ab898db300e397dda56673f7acea61fb3a306b9d15c17f7/githubstar-1.1.0.tar.gz",
"platform": null,
"description": "# githubstar\n\nExport GitHub starred repositories, lists and topics to HTML, JSON, Markdown, or bookmark, grouped by language or topic, ordered by time, stargazer count etc.\n\n## Installation\n\n- Using [pip](https://pypi.org/project/githubstar/)\n```\n$ pip install githubstar\n```\n\n- Using Binaries (x64 architecture only) from [Release page](https://github.com/avalogic/githubstar/releases)\n\n- You can also clone the repo and build from source\n\n\n## Quick Start\n\nRun with a username\n```\n$ githubstar --username <username>\n```\nRun with username, GitHub access token, and default options\n```\n$ export GITHUB_TOKEN=<Access-Token>\n$ githubstar --username <username>\n```\nor\n```\n$ githubstar --username <username> --token <Access-Token>\n```\nExport to json format \n```\n$ githubstar --username <username> --token <Access-Token> --format json\n```\n\nRun with language grouping and bookmark format \n```\n$ githubstar --username <username> --token <Access-Token> --format bookmark --groupby language\n```\n\n## Usage\n\n```\n$ githubstar -h\n\nusage: githubstar [-h] [--version] --username USERNAME [--token TOKEN] [--format {html,json,md,bookmark}]\n [--groupby {none,language,topic}]\n [--orderby {timestarred,timeupdated,alphabet,starscount,forkscount,language}]\n [--orderdirection {desc,asc}] [--ordernum {true,false}] [--excludeprivate {true,false}]\n [--destpath DESTPATH] [--destname DESTNAME]\n\nExport a GitHub user's starred list to local file.\n\noptions:\n -h, --help show this help message and exit\n --version show the program's version number and exit\n --username USERNAME [required]username to export for\n --token TOKEN the token from https://github.com/settings/tokens, to avoid rate limiting, can also store in\n environment as 'GITHUB_TOKEN'.\n --format {html,json,md,bookmark}\n output format, default: html\n --groupby {none,language,topic}\n default: none\n --orderby {timestarred,timeupdated,reponame,starscount,forkscount,language}\n default: timestarred\n --orderdirection {desc,asc}\n default: desc\n --ordernum {true,false}\n choose whether to display the order number before the repository name, default: true\n --excludeprivate {true,false}\n exclude private repositories, default: false\n --destpath DESTPATH path to store the exported file\n --destname DESTNAME filename of the exported file\n```\n\n## FAQ\n\n - What does 'RateLimitExceededException' mean?\n \n 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.\n \n\n - Where to get the access token? \n\n 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.\n \n - [https://github.com/settings/personal-access-tokens](https://github.com/settings/personal-access-tokens)\n - [https://github.com/settings/tokens](https://github.com/settings/tokens)\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 avalogic\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Export Github starred repos list to file",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/avalogic/githubstar"
},
"split_keywords": [
"github",
" star",
" stars",
" starred",
" export"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "13d69130d191867d96d000ed32d78152fc229390402a6a353bbb963de8802cf6",
"md5": "55145e5ea5754d17e29d4ea676f2bfb3",
"sha256": "1fffcc6b2226ead40e4946a997ed8896cdcca29c97cc76420adad27cf7e0c3e8"
},
"downloads": -1,
"filename": "githubstar-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "55145e5ea5754d17e29d4ea676f2bfb3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13",
"size": 19789,
"upload_time": "2025-07-09T08:32:20",
"upload_time_iso_8601": "2025-07-09T08:32:20.655764Z",
"url": "https://files.pythonhosted.org/packages/13/d6/9130d191867d96d000ed32d78152fc229390402a6a353bbb963de8802cf6/githubstar-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e56584be19b4dd451ab898db300e397dda56673f7acea61fb3a306b9d15c17f7",
"md5": "37d75d96a8e8ee170c7f92c1046c4d03",
"sha256": "3c56c1f83c5d802f8a03925c9d277b9da9df10e77812239e36f30d13ca547ee1"
},
"downloads": -1,
"filename": "githubstar-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "37d75d96a8e8ee170c7f92c1046c4d03",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13",
"size": 20390,
"upload_time": "2025-07-09T08:32:21",
"upload_time_iso_8601": "2025-07-09T08:32:21.745626Z",
"url": "https://files.pythonhosted.org/packages/e5/65/84be19b4dd451ab898db300e397dda56673f7acea61fb3a306b9d15c17f7/githubstar-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 08:32:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "avalogic",
"github_project": "githubstar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "PyGithub",
"specs": [
[
">=",
"1.59.1"
],
[
"<",
"2.0.0"
]
]
},
{
"name": "requests",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "beautifulsoup4",
"specs": []
}
],
"lcname": "githubstar"
}
