Skip to main content

Simple command-line app for querying assigned Issues and PRs from Github.

Project description

Build Status

gitmine

Stop getting buried under countless Github Issues and PRs. Organize, reference, and close with ease.

Based on the amazing work done by Github itself on hub and Github CLI (release while we were working on this project. Well done, us).

Who is this for?

I work on a lot of projects across many repositories. It was a pain in the a$$ to keep track of all the Issues I was assigned and PRs I had to review. Some tools provided a quick way to see Issues from one repository, but I needed a quick way to view, organize and open from any of these projects, thus gitmine was born.

If you aren't a heavy user of Github or maybe only have one repository you focus on, this is probably more than you need.

Usage

Command Line Arguments

Usage: gitmine [OPTIONS] COMMAND [ARGS]...

  Simple command-line tool for querying assigned Issues and PR reviews from
  Github.

Options:
  -v, --verbose  Give more output. Option is additive, and can be used up to
                 three times.
  --help         Show this message and exit.

Commands:
  config  Set or Access Github Config information.
  get     Get assigned Github Issues and/or Github PRs.
  go      Open a browser page for the given repositiory / issue.

Config

To use gitmine you will first need to generate a Personal Access Token. You can follow the instructions here

gitmine config username ~git-username~
gitmine config token ~git-token~

Gitmine gives you the option to encrypt your credentials with the --encrypt option.

Installation

From PyPi

pip install gitmine

From source

pip install 'git+https://github.com/joecummings/gitmine.git'

Contributing

See Contributing.md

Common Errors and FAQ's

  • Running gitmine get prs with the wrong username will not error but return nothing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitmine-0.0.9.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

gitmine-0.0.9-py3-none-any.whl (11.4 kB view details)

Uploaded Python 3

File details

Details for the file gitmine-0.0.9.tar.gz.

File metadata

  • Download URL: gitmine-0.0.9.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for gitmine-0.0.9.tar.gz
Algorithm Hash digest
SHA256 aabd514eb8f16701de5dee9be88a37b95c6fa886fc24fa944e95c3b35a66bbe5
MD5 84119fea9e97ee8d1a562a4412558768
BLAKE2b-256 849dcb5eca08a93c12a8d65cd1c47d98e6acab61138e0ec5de8a39c5da8b9aeb

See more details on using hashes here.

File details

Details for the file gitmine-0.0.9-py3-none-any.whl.

File metadata

  • Download URL: gitmine-0.0.9-py3-none-any.whl
  • Upload date:
  • Size: 11.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for gitmine-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 41b0157a0c145acc3910a5a742e57ebd01e6d79406ce7d19aeae1db51cc0c289
MD5 adc483a6d46787292faafa211462b3d5
BLAKE2b-256 550a04812bfbe1d0e64b29cdd38ded89be67dcae625476622531d96695506eb5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page