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 git repositories, commits, directories, and files in the browser. See also, git-reviewers.

Preview

This script 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.

Git Browse supports opening git repositories, commits, directories, and files:

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] [-c] [-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
  -c, --copy         Copy url to clipboard, if available
  -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
git browse --sourcegraph https://sourcegraph.com/github.com/albertyw/git-browse
git browse --godocs https://godocs.io/github.com/albertyw/git-browse
git browse for Bitbucket https://bitbucket.org/albertyw/asdf
git browse for Gitlab https://gitlab.com/albertyw/asdf
git browse for Uber Phabricator https://code.uberinternal.com/diffusion/rASDF/repository/master/

Related Projects

Development

pip install -r requirements-test.txt
ruff check .
mypy . --strict --ignore-missing-imports
coverage run -m unittest
coverage report

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

Uploaded Source

Built Distribution

git_browse-2.13.9-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: git-browse-2.13.9.tar.gz
  • Upload date:
  • Size: 12.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for git-browse-2.13.9.tar.gz
Algorithm Hash digest
SHA256 61a742e1c8a1bc3777db785081a9c3a3c978643e6d6cde8ce7215ac8d0e6c3db
MD5 1ebfadf4a3b1a293e5fa31e70af61fcf
BLAKE2b-256 b20bbcb4f8e5016989eb8fd8719e867b8f62f42999fb8d91655e092da9a13584

See more details on using hashes here.

File details

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

File metadata

  • Download URL: git_browse-2.13.9-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for git_browse-2.13.9-py3-none-any.whl
Algorithm Hash digest
SHA256 2bfc4af4b91df04d43ae5c2f5e4fbed24e40e2cf2bb04adb9c492bd16eef8bec
MD5 1d1f4973b2d38a5e1552368070e5adb0
BLAKE2b-256 4336752c57b96219514c7246dd941a9d1a5d42e7f1be60167be7149330862a96

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