https://github.com/marius92mc/github-stargazers
List stargazers and check if a user starred that repository.
https://github.com/marius92mc/github-stargazers
command-line github github-stars python3
Last synced: 8 days ago
JSON representation
List stargazers and check if a user starred that repository.
- Host: GitHub
- URL: https://github.com/marius92mc/github-stargazers
- Owner: marius92mc
- License: mit
- Created: 2017-10-11T18:59:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-06T08:29:25.000Z (almost 7 years ago)
- Last Synced: 2025-09-13T16:21:40.944Z (4 months ago)
- Topics: command-line, github, github-stars, python3
- Language: Python
- Homepage: https://pypi.python.org/pypi/github-stargazers
- Size: 74.2 KB
- Stars: 14
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/marius92mc/github-stargazers)
[](https://badge.fury.io/py/github-stargazers)
[](http://hits.dwyl.io/marius92mc/github-stargazers)
[](https://twitter.com/intent/tweet?text=GitHub+Stargazers+on+PyPi!&url=https%3A%2F%2Fgithub.com%2Fmarius92mc%2Fgithub-stargazers&hashtags=github&original_referer=http%3A%2F%2Fgithub.com%2F&tw_p=tweetbutton)
List stargazers and check if a user starred that repository.
## Install
It is recommended to be installed in a virtual environment with `Python >= 3.6`.
- Install pipenv
```
$ pip3 install pipenv
```
- After `cd` into a working directory, configure virtual environment and install `github-stargazers`
```
$ pipenv --python=python3.6
$ pipenv install github-stargazers
```
## Usage
### As a command-line app
```
$ pipenv run github-stargazers / [OPTIONS]
```
where `OPTIONS` could be
```
--user GitHub username to see if it is a stargazer.
```
If it's used without `--user`, it just shows repository's stargazers.
When it's used with `--user`, it shows if that user starred the repository or not.
Example:
```
$ pipenv run github-stargazers marius92mc/github-stargazers --user marius92mc
```
### As an imported
```Python
from github_stargazers.github import GitHub
github = GitHub("yasoob/fb-messenger-bot")
print(github.get_all_stargazers())
print(github.is_stargazer("Jazzthedog"))
```
## Running from source
### Requirements
- Python 3.6
- [pipenv](https://docs.pipenv.org/)
### Getting started
1. Install pipenv
```
$ pip3 install pipenv
```
2. Set Python 3.6 as the version used by pipenv to create the virtual environment
```
$ cd github_stargazers
$ pipenv --python=python3.6
```
3. Install dependencies
```
$ pipenv install --dev
```
### Run
First we need to install the package, according to `setup.py` instructions.
```
$ pipenv run python setup.py install
```
Then we can run the installed package inside pipenv.
```
$ pipenv run github-stargazers / [OPTIONS]
```
where `OPTIONS` could be
```
--user GitHub username to see if it is a stargazer.
```
### Run autopep8, mypy, pylint for the changed files
```
$ ./autopep8.sh
$ ./mypy.sh
$ ./pylint.sh
```
### Launch IPython console
```
$ pipenv run ipython
```
### Tests
Run the unit-tests.
```
$ pipenv run pytest
```
or with more detailed output, like this `$ pipenv run pytest -vv`.
- Debug failing tests
```
$ pipenv run pytest -vv -s -x --pdb --showlocals
```
For more details, see the [pytest documentation](https://docs.pytest.org/en/latest/usage.html).