Metadata-Version: 2.1
Name: githubstar
Version: 1.0.0
Summary: Export Github starred repos list to file
Author: designbeta@github
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.
        
Project-URL: Homepage, https://github.com/designbeta/githubstar
Keywords: github,star,stars,starred,export
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyGithub <2.0.0,>=1.59.1

# 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)
