Skip to main content

Open repositories, directories, and files in the browser

Project description

Git Browse

PyPI PyPI - Python Version PyPI - License

Codeship Status for albertyw/git-browse Dependency Status Code Climate Test Coverage

Open repositories, directories, and files in the browser. See also, git-reviewers.

Preview

This is a script that can be added as a gitconfig alias to easily browse repositories on Git hosting services (e.g. github). It is built to model arcanist's browse command. It is specifically designed to have no dependencies so it should be easily installable and very portable.

If you're looking to browse different github repositories, you might like hub browse.

Installation

HomeBrew (preferred for MacOS)

If you use Homebrew, you can install git-browse through the homebrew-albertyw tap:

brew install albertyw/albertyw/git-browse

Manual

If you don't use Homebrew, first clone this repository to somewhere on your system (perhaps in your dotfiles repository), then run <REPOSITORY_LOCATION>/install.sh.

Usage

$ git browse -h
'browse' is aliased to '!~/.dotfiles/scripts/git/git-browse/git_browse/browse.py --path=${GIT_PREFIX:-./}'
usage: browse.py [-h] [--path PATH] [-d] [-s] [-g] [-v] [target]

Open repositories, directories, and files in the browser. https://github.com/albertyw/git-browse

positional arguments:
  target             file, directory, git hash, or git branch you wish to browse

optional arguments:
  -h, --help         show this help message and exit
  --path PATH        relative path to the current git repository
  -d, --dry-run      Do not open the url in the brower, and only print to stdout
  -s, --sourcegraph  Open objects in sourcegraph
  -g, --godocs       Open objects in godocs
  -v, --version      show program's version number and exit

Examples

Command Opens
git browse https://github.com/albertyw/git-browse
git browse README.md https://github.com/albertyw/git-browse/blob/master/README.md
git browse git_browse https://github.com/albertyw/git-browse/tree/master/git_browse/
git browse v1.1.1 https://github.com/albertyw/git-browse/commit/80b219dee0aaa86b378993cbf88511126b813c5f

Related Projects

Development

pip install -r requirements-test.txt
coverage run setup.py test
coverage report
flake8
mypy git_browse/browse.py

Publishing

pip install twine
python setup.py sdist bdist_wheel
twine upload dist/*

Need to also update albertyw/homebrew-albertyw.

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

git-browse-2.8.3.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

git_browse-2.8.3-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file git-browse-2.8.3.tar.gz.

File metadata

  • Download URL: git-browse-2.8.3.tar.gz
  • Upload date:
  • Size: 8.5 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 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for git-browse-2.8.3.tar.gz
Algorithm Hash digest
SHA256 089bf8e57ee79ca7baa9b7325c251fcdab8b418be68b48e567941d03632f664f
MD5 06391fcc55889fa22d4f780ee1f80471
BLAKE2b-256 67a97063af9b3a8784502849bdca9a7018fd21461d1065b70123d7c0677238c0

See more details on using hashes here.

File details

Details for the file git_browse-2.8.3-py3-none-any.whl.

File metadata

  • Download URL: git_browse-2.8.3-py3-none-any.whl
  • Upload date:
  • Size: 7.3 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 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.8.5

File hashes

Hashes for git_browse-2.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a998401c5833a41be616f9a16f781a7e8cdec05d3a2fca873ae4db38b5f83570
MD5 760ea1223e5ee0c0624f6401826ba344
BLAKE2b-256 fccd40976a5bab6ff1cff86b4b2ebef02d15d9c010434eec21e56559404ae6ec

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