Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arbal/starred

creating your own Awesome List by GitHub stars!
https://github.com/arbal/starred

Last synced: about 2 months ago
JSON representation

creating your own Awesome List by GitHub stars!

Awesome Lists containing this project

README

        

# Starred

[![ci](https://github.com/arbal/starred/actions/workflows/ci.yml/badge.svg)](https://github.com/arbal/starred/actions/workflows/ci.yml)

## Install

```bash

$ pip install starred
$ starred --username arbal --sort > README.md
```

## Usage

```bash
$ starred --help

Usage: starred [OPTIONS]

GitHub starred

creating your own Awesome List used GitHub stars!

example: starred --username arbal --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

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

## Forked from
- [`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

## FAQ

1. Generate new token

link: [Github Personal access tokens](https://github.com/settings/tokens)

2. Why do I need a token?

- For unauthenticated requests, the rate limit is 60 requests per
hour.
see [Github Api Rate
Limiting](https://developer.github.com/v3/#rate-limiting)
- The token must be passed together when you want to automatically
create the repository.

3. Install the master branch version

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