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.

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.8.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

gitmine-0.0.8-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gitmine-0.0.8.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.7

File hashes

Hashes for gitmine-0.0.8.tar.gz
Algorithm Hash digest
SHA256 626ffcd192612df7020821642efd72c899ee6faa88489922643386ab73a72dc3
MD5 2ca53b7b941eb8f92ffbebfad434552b
BLAKE2b-256 646960934173faa07d34571dbd39424531112989abfef27afac28df1b0942b63

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gitmine-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.7

File hashes

Hashes for gitmine-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 e0aa6e338a42202f6032779fc473f2be93ad5291cb1155fb5cbb33b53a91ec73
MD5 8dc2209b7fd9d94b1848a5c2644b5559
BLAKE2b-256 2a02b9d9483e1fb3fd1a2e90cc354c56bc9f98c8999c78405c9eaa7c5524520d

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