Skip to main content

creating your own Awesome List used GitHub stars!

Project description

Starred

ci Upload 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

    $ 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-4.2.0.tar.gz (6.6 kB view hashes)

Uploaded source

Built Distribution

starred-4.2.0-py2.py3-none-any.whl (6.8 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page