# Starred
[](https://github.com/maguowei/starred/actions/workflows/ci.yml)
[](https://github.com/maguowei/starred/actions/workflows/deploy.yml)
## Install
```bash
$ pip install starred
$ starred --username maguowei --token=xxxxxxxx --sort > README.md
```
## Usage
```bash
$ 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
```bash
# automatically create the repository
$ export GITHUB_TOKEN=yourtoken
$ starred --username yourname --repository awesome-stars --sort
```
- [`maguowei/awesome-stars`](https://github.com/maguowei/awesome-stars)
- [update awesome-stars every day by GitHub Action](https://github.com/maguowei/awesome-stars/blob/master/.github/workflows/schedules.yml) 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:
- https://github.com/topics/starred
- https://github.com/topics/awesome-stars
## Use [awesome-stars](https://github.com/maguowei/awesome-stars) as template
The simple way to create an awesome-stars repository is to use [maguowei/awesome-stars](https://github.com/maguowei/awesome-stars/generate) as template.
It will auto update your awesome-stars repository every day by GitHub Action.
1. Click [Create a new repository from awesome-stars](https://github.com/maguowei/awesome-stars/generate)
2. [Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)
set permissions to `Read and write permissions` and click `Save` button
3. Run the workflow first time
click `Run workflow` button
4. Customize the workflow schedule
- [.github/workflows/schedules.yml#L5](https://github.com/maguowei/awesome-stars/blob/master/.github/workflows/schedules.yml#L5)
## FAQ
1. Generate new token
link: [Github Personal access tokens](https://github.com/settings/tokens)
2. Install the master branch version
```bash
$ poetry build
$ pip install dist/starred-${x.x.x}.tar.gz
```
3. Dev & Run
```bash
poetry run starred --help
```
Raw data
{
"_id": null,
"home_page": "https://github.com/maguowei/starred",
"name": "starred",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "GitHub starred,starred",
"author": "maguowei",
"author_email": "imaguowei@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7f/81/ff57599c09e10539ae0ae8f274803b6303f750f792e107240272797d6417/starred-4.3.0.tar.gz",
"platform": null,
"description": "# Starred\n\n[](https://github.com/maguowei/starred/actions/workflows/ci.yml)\n[](https://github.com/maguowei/starred/actions/workflows/deploy.yml)\n\n## Install\n\n```bash\n\n$ pip install starred\n$ starred --username maguowei --token=xxxxxxxx --sort > README.md\n```\n\n## Usage\n\n```bash\n$ starred --help\n\nUsage: starred [OPTIONS]\n\n GitHub starred\n\n creating your own Awesome List by GitHub stars!\n\n example: starred --username maguowei --token=xxxxxxxx --sort > README.md\n\nOptions:\n --username TEXT GitHub username [required]\n --token TEXT GitHub token [required]\n --sort sort by category[language/topic] name alphabetically\n [default: False]\n\n --topic category by topic, default is category by language\n [default: False]\n\n --topic_limit INTEGER topic stargazer_count gt number, set bigger to reduce\n topics number [default: 500]\n\n --repository TEXT repository name [default: ]\n --filename TEXT file name [default: README.md]\n --message TEXT commit message [default: update stars]\n --private include private repos [default: False]\n --version Show the version and exit.\n --help Show this message and exit.\n```\n\n## Demo\n\n```bash\n# automatically create the repository\n$ export GITHUB_TOKEN=yourtoken\n$ starred --username yourname --repository awesome-stars --sort\n```\n\n- [`maguowei/awesome-stars`](https://github.com/maguowei/awesome-stars)\n- [update awesome-stars every day by GitHub Action](https://github.com/maguowei/awesome-stars/blob/master/.github/workflows/schedules.yml) the example with GitHub Action\n\n### Who uses starred?\n\n- by search: https://github.com/search?p=1&q=%22Generated+by+starred%22&type=Code\n- by topics:\n - https://github.com/topics/starred\n - https://github.com/topics/awesome-stars\n\n## Use [awesome-stars](https://github.com/maguowei/awesome-stars) as template\n\nThe simple way to create an awesome-stars repository is to use [maguowei/awesome-stars](https://github.com/maguowei/awesome-stars/generate) as template.\nIt will auto update your awesome-stars repository every day by GitHub Action.\n\n1. Click [Create a new repository from awesome-stars](https://github.com/maguowei/awesome-stars/generate)\n\n\n\n2. [Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)\n\nset permissions to `Read and write permissions` and click `Save` button\n\n\n\n3. Run the workflow first time\n\nclick `Run workflow` button\n\n\n\n4. Customize the workflow schedule\n\n- [.github/workflows/schedules.yml#L5](https://github.com/maguowei/awesome-stars/blob/master/.github/workflows/schedules.yml#L5)\n\n\n\n## FAQ\n\n1. Generate new token\n\n link: [Github Personal access tokens](https://github.com/settings/tokens)\n\n2. Install the master branch version\n\n ```bash\n $ poetry build \n $ pip install dist/starred-${x.x.x}.tar.gz\n ```\n3. Dev & Run\n ```bash\n poetry run starred --help\n ```",
"bugtrack_url": null,
"license": "MIT",
"summary": "creating your own Awesome List used GitHub stars!",
"version": "4.3.0",
"split_keywords": [
"github starred",
"starred"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "66e0ac8181af2f28e92cfa2d8a340190a2dcc2b89083c581328db41a48e65e2a",
"md5": "89fe08b61bfb53558a404bca82d1928d",
"sha256": "f50f2f07db97b8f9d52ed899ae304fbe57828dde6c66a78eeebfbae6289af050"
},
"downloads": -1,
"filename": "starred-4.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "89fe08b61bfb53558a404bca82d1928d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 8109,
"upload_time": "2023-01-14T16:02:52",
"upload_time_iso_8601": "2023-01-14T16:02:52.114843Z",
"url": "https://files.pythonhosted.org/packages/66/e0/ac8181af2f28e92cfa2d8a340190a2dcc2b89083c581328db41a48e65e2a/starred-4.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f81ff57599c09e10539ae0ae8f274803b6303f750f792e107240272797d6417",
"md5": "7b19ac6d52dab238071228b262f43e57",
"sha256": "ffda9ffcd6abe91c0a0607e9d91d19728914306078897c5dcedcca258ed0a7bf"
},
"downloads": -1,
"filename": "starred-4.3.0.tar.gz",
"has_sig": false,
"md5_digest": "7b19ac6d52dab238071228b262f43e57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 6205,
"upload_time": "2023-01-14T16:02:53",
"upload_time_iso_8601": "2023-01-14T16:02:53.271105Z",
"url": "https://files.pythonhosted.org/packages/7f/81/ff57599c09e10539ae0ae8f274803b6303f750f792e107240272797d6417/starred-4.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-14 16:02:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "maguowei",
"github_project": "starred",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "starred"
}
JSON
