Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dtolnay/star-history

Graph history of GitHub stars of a user or repo over time
https://github.com/dtolnay/star-history

Last synced: about 5 hours ago
JSON representation

Graph history of GitHub stars of a user or repo over time

Awesome Lists containing this project

README

        

GitHub star history
===================

[github](https://github.com/dtolnay/star-history)
[crates.io](https://crates.io/crates/star-history)
[build status](https://github.com/dtolnay/star-history/actions?query=branch%3Amaster)

Command line program to generate a graph showing number of GitHub stars of a
user, org or repo over time.

```console
$ cargo install star-history
```

*Compiler support: requires rustc 1.46+*


## Screenshot

![star history of rust-lang/rust](https://user-images.githubusercontent.com/1940490/72231437-3761ff80-3570-11ea-8658-6a269feb3a21.png)


## Usage

We require a token for accessing GitHub's GraphQL API. If you have the [GitHub
CLI] (`gh`) installed, you can run `gh auth status` to find out whether a token
is already set up on your machine, and `gh auth login` if one isn't.

[GitHub CLI]: https://cli.github.com

```console
$ gh auth login

$ star-history dtolnay
$ star-history serde-rs
$ star-history rust-lang/rust
```

Simply pass multiple arguments to display multiple users or repositories on the
same graph.

The generated graphs use [D3](https://d3js.org/); the star-history command
should pop open a browser showing your graph. It uses the same mechanism that
`cargo doc --open` uses so hopefully it works well on various systems.

If you prefer not to use the `gh` CLI, you can instead provide a token to
star-history through the GITHUB\_TOKEN environment variable. Head to
and click "Generate new token (classic)".
The default public access permission is sufficient — you can leave all the
checkboxes empty. Save the generated token somewhere like ~/.githubtoken. Then
`export GITHUB_TOKEN=$(cat ~/.githubtoken)` prior to running star-history
commands.


#### License


Licensed under either of Apache License, Version
2.0
or MIT license at your option.



Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in this crate by you, as defined in the Apache-2.0 license, shall
be dual licensed as above, without any additional terms or conditions.