Skip to main content

creating your own Awesome List used GitHub stars!

Project description

Travis CI Status Requirements Status

Install

$ pip install starred
$ starred --username maguowei --sort > README.md

starred requires Python version 3.x, If you require Python 2.x support
$ pip install starred==2.0.3

Usage

$ starred --help

Usage: starred [OPTIONS]

  GitHub starred

  creating your own Awesome List used GitHub stars!

  example:     starred --username maguowei --sort > README.md

Options:
  --username TEXT    GitHub username
  --token TEXT       GitHub token
  --sort             sort by language
  --repository TEXT  repository name
  --message TEXT     commit message
  --version          Show the version and exit.
  --help             Show this message and exit.

Demo

# automatically create the repository
$ export GITHUB_TOKEN=yourtoken
$ starred --username yourname --repository awesome-stars --sort

FAQ

  1. Generate new token

    goto Personal access tokens

  2. Why do I need a token?

    • For unauthenticated requests, the rate limit is 60 requests per hour. see Rate Limiting

    • The token must be passed together when you want to automatically create the repository.

  3. Install the master branch version

    $ pip install -e git+https://github.com/maguowei/starred#egg=starred

Project details


Download files

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

Source Distribution

starred-3.0.0.tar.gz (4.2 kB view hashes)

Uploaded Source

Built Distributions

starred-3.0.0-py3.6.egg (6.2 kB view hashes)

Uploaded Source

starred-3.0.0-py2.py3-none-any.whl (4.7 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page