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

Uploaded Source

Built Distribution

gitmine-0.0.4-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gitmine-0.0.4.tar.gz
  • Upload date:
  • Size: 7.2 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.4.tar.gz
Algorithm Hash digest
SHA256 76260402aa48d32480f3acdba4fc06f11c090fc1d1356c5580c5b6af2db645ed
MD5 01d6e7e40e7f620e217bad3ce693740e
BLAKE2b-256 faab27537fd8f0982294ceb4f7ef16dca9b0d88300748b1b97a696d2c72fe8c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gitmine-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 10.2 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b404467c0551f9be81cddc0b08965d353ad05ee5a1fc38babbcb8f6908a58196
MD5 88479c751415904a04df7ce0e6d5c5b1
BLAKE2b-256 f8134f5a80594a2279bf72d56b3b89eefc79e5b94b2dc3c7900572e1a6283e28

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