| Name | githubstar JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | Export Github starred repos list to file |
| upload_time | 2023-09-08 10:11:13 |
| maintainer | |
| docs_url | None |
| author | designbeta@github |
| requires_python | >=3.11 |
| license | MIT License Copyright (c) 2023 designbeta 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 |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# githubstar
Export Github starred repos list to html, bookmark, json or markdown format, grouped by language or topics, order by time, stargazers count etc..
## Installation
- Using [pip](https://pypi.org/project/githubstar/)
```
$ pip install githubstar
```
- Using Binaries (x64 architecture only) from [Release page](https://github.com/designbeta/githubstar/releases)
- You can also clone the repo and build from source
## Quick Start
Run with 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>
```
Run with language grouped 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,bookmark,md,json}]
[--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 program's version number and exit
--username USERNAME [required]username to export from
--token TOKEN token from https://github.com/settings/tokens, to avoid rate-limiting, can also store in
environment as 'GITHUB_TOKEN'.
--format {html,bookmark,md,json}
output format, default: html
--groupby {none,language,topic}
default: none
--orderby {timestarred,timeupdated,alphabet,starscount,forkscount,language}
default: timestarred
--orderdirection {desc,asc}
default: desc
--ordernum {true,false}
show order number before repository name or not, 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
- A 'RateLimitExceededException' error is met?
The Github API rate limiting is reached. An access token is needed in this case. Check out this [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?
Login with your Github account and go to this page: [https://github.com/settings/tokens](https://github.com/settings/tokens)
Raw data
{
"_id": null,
"home_page": "",
"name": "githubstar",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "github,star,stars,starred,export",
"author": "designbeta@github",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/56/1b/811b4cd8242bb3b373307bff003f871c1a7e89813072c844304c5909c23f/githubstar-1.0.0.tar.gz",
"platform": null,
"description": "# githubstar\n\nExport Github starred repos list to html, bookmark, json or markdown format, grouped by language or topics, order by time, stargazers 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/designbeta/githubstar/releases)\n\n- You can also clone the repo and build from source\n\n\n## Quick Start\n\nRun with 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```\nRun with language grouped 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,bookmark,md,json}]\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 program's version number and exit\n --username USERNAME [required]username to export from\n --token TOKEN token from https://github.com/settings/tokens, to avoid rate-limiting, can also store in\n environment as 'GITHUB_TOKEN'.\n --format {html,bookmark,md,json}\n output format, default: html\n --groupby {none,language,topic}\n default: none\n --orderby {timestarred,timeupdated,alphabet,starscount,forkscount,language}\n default: timestarred\n --orderdirection {desc,asc}\n default: desc\n --ordernum {true,false}\n show order number before repository name or not, 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 - A 'RateLimitExceededException' error is met?\n \n The Github API rate limiting is reached. An access token is needed in this case. Check out this [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 Login with your Github account and go to this page: [https://github.com/settings/tokens](https://github.com/settings/tokens)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 designbeta 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. ",
"summary": "Export Github starred repos list to file",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/designbeta/githubstar"
},
"split_keywords": [
"github",
"star",
"stars",
"starred",
"export"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bc17164cb98127ceb2bbb9793ecae6f5d8407988fc43a5c1b701cc6afffe8d1b",
"md5": "135da4dc3ea17f8373094ef143228d7c",
"sha256": "8712063b2c73bb36d63db23d332016797e9a9d7ea00fe5214a97d1267a484757"
},
"downloads": -1,
"filename": "githubstar-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "135da4dc3ea17f8373094ef143228d7c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 14819,
"upload_time": "2023-09-08T10:11:12",
"upload_time_iso_8601": "2023-09-08T10:11:12.113878Z",
"url": "https://files.pythonhosted.org/packages/bc/17/164cb98127ceb2bbb9793ecae6f5d8407988fc43a5c1b701cc6afffe8d1b/githubstar-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "561b811b4cd8242bb3b373307bff003f871c1a7e89813072c844304c5909c23f",
"md5": "8dcb903003ae148cf56079edc2a5f7a2",
"sha256": "abb251eed99e86a9335b0ef20e276f2d30a98382588bf207b92805c4fc60a536"
},
"downloads": -1,
"filename": "githubstar-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "8dcb903003ae148cf56079edc2a5f7a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 15453,
"upload_time": "2023-09-08T10:11:13",
"upload_time_iso_8601": "2023-09-08T10:11:13.630122Z",
"url": "https://files.pythonhosted.org/packages/56/1b/811b4cd8242bb3b373307bff003f871c1a7e89813072c844304c5909c23f/githubstar-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-08 10:11:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "designbeta",
"github_project": "githubstar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "githubstar"
}
