Awesome
Starred
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
maguowei/awesome-stars
- update awesome-stars every day by GitHub Action the example with GitHub Action
Who uses starred?
- by search: https://github.com/search?p=1&q=%22Generated+by+starred%22&type=Code
- by topics:
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.
set permissions to Read and write permissions
and click Save
button
- Run the workflow first time
click Run workflow
button
- Customize the workflow schedule
FAQ
-
Generate new token
-
Install the master branch version
$ poetry build $ pip install dist/starred-${x.x.x}.tar.gz
-
Dev & Run
poetry run starred --help