Skip to main content

Open repositories, directories, and files in the browser

Project description

Git Browse

PyPI PyPI - Python Version PyPI - License

Build Status 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

  1. Update changelog and __version__ variable with a semantic version
  2. Commit changes, create a version tag, and push both
  3. 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.11.0.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

git_browse-2.11.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: git-browse-2.11.0.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for git-browse-2.11.0.tar.gz
Algorithm Hash digest
SHA256 469f0ae874ea493730ac6ad35b6db45d512f147481f9db6d5ba6e26b60e2077c
MD5 68cfc42b77e7c582062b492066b447c5
BLAKE2b-256 0a2061763e96c9a89b7cd27dd55ef6f6a1404b4a9873509ee9f7d11a596cee55

See more details on using hashes here.

File details

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

File metadata

  • Download URL: git_browse-2.11.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for git_browse-2.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cbde7aa774851b7f4299fa73a81362008eaa3048a272b65ff144f07de0dd4037
MD5 a08a839843fe4273f6b33f3ed3bb6f45
BLAKE2b-256 dfecb86e8c4d19e5f76ad9545f18101fcdbf4a08f259373828835df1ef0a9f1b

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