albertyw / git-browse Goto Github PK

View Code? Open in Web Editor NEW

24.0 4.0 3.0 238 KB

Open git files, directories, hashes, tags, and branches in the browser

License: MIT License

Python 98.95% Shell 1.05%

github python-3 browser phabricator git-browse git sourcegraph bitbucket version-control gitlab

git-browse's Introduction

Git Browse

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

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 -e .[test]
ruff check .
mypy . --strict --ignore-missing-imports
coverage run -m unittest
coverage report

Publishing

Update changelog and __version__ variable with a semantic version
Commit changes, create a version tag, and push both
Update albertyw/homebrew-albertyw

git-browse's People

Contributors

Stargazers

Watchers

Forkers

cdlewis pombredanne zyqilla

git-browse's Issues

Support GitLab

Will implement after I get one person who wants this.

Compare setup.py against kennethreitz/setup.py

https://github.com/kennethreitz/setup.py

Make this installable by brew

Convert readme from rst to md

Python 3 check incorrect

The import configparser check does not fully check if the code is python 3.

Get test coverage back to 100%

Support github enterprise deployments

Modularize code and distribute zipped version of code

The current browse.py file is getting a bit too large. It should be broken up and repackaged as a single executable for distribution: http://blog.ablepear.com/2012/10/bundling-python-files-into-stand-alone.html

Support opening phabricator repositories without an .arcconfig

Maybe create a whitelist of known phabricator repository urls?

Deal with sourcegraph not hosting personal repositories anymore

https://about.sourcegraph.com/blog/single-tenant-cloud

Stop relying on arcanist for phabricator

Instead of using arcanist for opening phabricator-based repositories, generate them from string concatenation like how github works. This reduces dependencies and simplifies git-browse.

Support running with multiple fetch configs

gitconfig allows for multiple fetch configs which breaks configparser: https://stackoverflow.com/questions/15507264/can-i-specify-in-git-config-to-fetch-multiple-refspecs

Add a script to self install this package

Rather than asking people to self install

Support git browsing a commit hash

Upload to pypi

https://pypi.python.org/pypi/git-browse

Include examples of all flags and repository providers into the README

Use better naming for object types

Support opening godocs

for uber:
https://eng.uberinternal.com/docs/api/go/pkg/host/repo*/

for github:
https://pkg.go.dev/go.uber.org/zap

Support bitbucket

Will implement after I get one person who wants this.

Switch readme to rst

pypi doesn't know how to parse markdown

Support code.uber.internal

Repository urls like https://code.uber.internal/x/y should be supported.

Repository names with `@` are not parseable

e.g. [email protected]:c/d@e

Add mypy type annotations

Support python 2

Initial Update

The bot created this issue to inform you that pyup.io has been set up on this repo.
Once you have closed it, the bot will open pull requests for updates as soon as they are available.