Skip to main content

List stargazers and check if a user starred that repository

Project description

Build Status PyPI version

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

$ pipenv run github-stargazers <username>/<repository> [OPTIONS]

where OPTIONS could be

--user <username>  User name to see if it is a stargazer.
                   username represents the GitHub name.

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

Running from source

Requirements

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 <username>/<repository> [OPTIONS]

where OPTIONS could be

--user <username>  User name to see if it is a stargazer,
                   where username represents the GitHub name.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
github-stargazers-0.0.4.tar.gz (4.4 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page