Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.91 KB

README.md

File metadata and controls

57 lines (38 loc) · 1.91 KB
Raw

pullpito 🐙 Build Status

Command-line for GitHub pull request statistics, similar to hubstats.

Implemented while learning Rust 🦀, reading The Rust Programming Language 🎓.

Pre-requisite

Install the rustup Rust toolchain.

Run

In order to display pull request events for a single public GitHub repository, run cargo --repository $org/$repo or cargo -r $org/$repo.

For instance, running cargo run --quiet -- --repository python/peps will display an output like:

pull requests for "python/peps" ->
  opened per author:
    ssbarnea: 1
    emilyemorehouse: 2
  commented per author:
    brettcannon: 2
  closed per author:
    brettcannon: 2
    gvanrossum: 6

For a private GitHub repository, run cargo run -- --repository $org/$repo --token $token.

For several GitHub repositories, use several repository arguments: cargo run -- --repository $repo1 --repository $repo2.

For more information, run cargo run -- --help.

Run with debug/trace logs

Log level can be changed via the RUST_LOG environment variable.

DEBUG logs add some internal info. They can be activated this way:

RUST_LOG=pullpito=debug cargo run -- --repository nicokosi/pullpito

TRACE logs are more detailed and contain sensitive data like the GitHub token. They can be activated this way:

RUST_LOG=pullpito=trace cargo run -- --repository nicokosi/pullpito

Install

Run cargo install --path .. You can then run the target/release/pullpito command directly.

Development cheat-sheet

  • Compile and run tests: cargo test
  • Format all the code: cargo fmt
  • Run the linter: cargo clippy