Home

Awesome

Starred

ci Publish Python Package

Install


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

Usage

$ starred --help

Usage: starred [OPTIONS]

  GitHub starred

  creating your own Awesome List by GitHub stars!

  example:     starred --username maguowei --token=xxxxxxxx --sort > README.md

Options:
  --username TEXT        GitHub username  [required]
  --token TEXT           GitHub token  [required]
  --sort                 sort by category[language/topic] name alphabetically
                         [default: False]

  --topic                category by topic, default is category by language
                         [default: False]

  --topic_limit INTEGER  topic stargazer_count gt number, set bigger to reduce
                         topics number  [default: 500]

  --repository TEXT      repository name  [default: ]
  --filename TEXT        file name  [default: README.md]
  --message TEXT         commit message  [default: update stars]
  --private              include private repos  [default: False]
  --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

Who uses starred?

Use awesome-stars as template

The simple way to create an awesome-stars repository is to use maguowei/awesome-stars as template. It will auto update your awesome-stars repository every day by GitHub Action.

  1. Click Create a new repository from awesome-stars

use-awesome-stars-as-template

  1. Setting the permissions of the GITHUB_TOKEN for your repository

set permissions to Read and write permissions and click Save button

workflow-permissions

  1. Run the workflow first time

click Run workflow button

run-workflow

  1. Customize the workflow schedule

schedule

FAQ

  1. Generate new token

    link: Github Personal access tokens

  2. Install the master branch version

    $ poetry build 
    $ pip install dist/starred-${x.x.x}.tar.gz
    
  3. Dev & Run

    poetry run starred --help