git-browse


Namegit-browse JSON
Version 2.13.10 PyPI version JSON
download
home_pageNone
SummaryOpen repositories, directories, and files in the browser
upload_time2024-04-20 05:16:41
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseMIT
keywords github phabricator repository browser
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Git Browse
==========

[![PyPI](https://img.shields.io/pypi/v/git-browse)](https://pypi.org/project/git-browse/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/git-browse)
![PyPI - License](https://img.shields.io/pypi/l/git-browse)

[![Build Status](https://drone.albertyw.com/api/badges/albertyw/git-browse/status.svg)](https://drone.albertyw.com/albertyw/git-browse)
[![Dependency Status](https://pyup.io/repos/github/albertyw/git-browse/shield.svg)](https://pyup.io/repos/github/albertyw/git-browse/)
[![Code Climate](https://codeclimate.com/github/albertyw/git-browse/badges/gpa.svg)](https://codeclimate.com/github/albertyw/git-browse)
[![Test Coverage](https://codeclimate.com/github/albertyw/git-browse/badges/coverage.svg)](https://codeclimate.com/github/albertyw/git-browse/coverage)


Open git repositories, commits, directories, and files in the browser. See also,
[git-reviewers](https://github.com/albertyw/git-reviewer).

![Preview](https://user-images.githubusercontent.com/3151040/28054498-e7cb0746-65c9-11e7-882e-dbf612f5b075.gif)

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](https://github.com/phacility/arcanist/blob/master/src/workflow/ArcanistBrowseWorkflow.php)
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:

 - [Bitbucket](https://bitbucket.org/)
 - [Github](https://github.com/)
 - [Gitlab](https://gitlab.com/)
 - [GoDocs](https://godocs.io/)
 - [Phabricator](https://www.phacility.com/phabricator/)
 - [Sourcegraph](https://about.sourcegraph.com/)

Installation
------------

### HomeBrew (preferred for MacOS)

If you use Homebrew, you can install git-browse through the
[homebrew-albertyw tap](https://github.com/albertyw/homebrew-albertyw>):

```bash
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](https://github.com/albertyw/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
----------------

- [git-brws](https://github.com/rhysd/git-brws)
- [hub browse](https://hub.github.com/)
- [git open](https://github.com/paulirish/git-open)
- [open-browser-github.vim](https://github.com/tyru/open-browser-github.vim)

Development
-----------

```bash
pip install -e .[test]
ruff check .
mypy .
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](https://github.com/albertyw/homebrew-albertyw)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "git-browse",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "github, phabricator, repository, browser",
    "author": null,
    "author_email": "Albert Wang <git@albertyw.com>",
    "download_url": "https://files.pythonhosted.org/packages/29/75/4f69662be5df1c0b159c5e8565d388d1e71bffe84620e1f5bb0c15001156/git_browse-2.13.10.tar.gz",
    "platform": null,
    "description": "Git Browse\n==========\n\n[![PyPI](https://img.shields.io/pypi/v/git-browse)](https://pypi.org/project/git-browse/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/git-browse)\n![PyPI - License](https://img.shields.io/pypi/l/git-browse)\n\n[![Build Status](https://drone.albertyw.com/api/badges/albertyw/git-browse/status.svg)](https://drone.albertyw.com/albertyw/git-browse)\n[![Dependency Status](https://pyup.io/repos/github/albertyw/git-browse/shield.svg)](https://pyup.io/repos/github/albertyw/git-browse/)\n[![Code Climate](https://codeclimate.com/github/albertyw/git-browse/badges/gpa.svg)](https://codeclimate.com/github/albertyw/git-browse)\n[![Test Coverage](https://codeclimate.com/github/albertyw/git-browse/badges/coverage.svg)](https://codeclimate.com/github/albertyw/git-browse/coverage)\n\n\nOpen git repositories, commits, directories, and files in the browser. See also,\n[git-reviewers](https://github.com/albertyw/git-reviewer).\n\n![Preview](https://user-images.githubusercontent.com/3151040/28054498-e7cb0746-65c9-11e7-882e-dbf612f5b075.gif)\n\nThis script can be added as a gitconfig alias to easily browse\nrepositories on Git hosting services (e.g. github). It is built to model\n[arcanist's browse](https://github.com/phacility/arcanist/blob/master/src/workflow/ArcanistBrowseWorkflow.php)\ncommand. It is specifically designed to have no\ndependencies so it should be easily installable and very portable.\n\nGit Browse supports opening git repositories, commits, directories, and files:\n\n - [Bitbucket](https://bitbucket.org/)\n - [Github](https://github.com/)\n - [Gitlab](https://gitlab.com/)\n - [GoDocs](https://godocs.io/)\n - [Phabricator](https://www.phacility.com/phabricator/)\n - [Sourcegraph](https://about.sourcegraph.com/)\n\nInstallation\n------------\n\n### HomeBrew (preferred for MacOS)\n\nIf you use Homebrew, you can install git-browse through the\n[homebrew-albertyw tap](https://github.com/albertyw/homebrew-albertyw>):\n\n```bash\nbrew install albertyw/albertyw/git-browse\n```\n\n### Manual\n\nIf you don't use Homebrew, first clone this repository to somewhere on\nyour system (perhaps in your [dotfiles](https://github.com/albertyw/dotfiles) repository), then run\n`<REPOSITORY_LOCATION>/install.sh`.\n\nUsage\n-----\n\n```\n$ git browse -h\n'browse' is aliased to '!~/.dotfiles/scripts/git/git-browse/git_browse/browse.py --path=${GIT_PREFIX:-./}'\nusage: browse.py [-h] [--path PATH] [-d] [-c] [-s] [-g] [-v] [target]\n\nOpen repositories, directories, and files in the browser. https://github.com/albertyw/git-browse\n\npositional arguments:\n  target             file, directory, git hash, or git branch you wish to browse\n\noptional arguments:\n  -h, --help         show this help message and exit\n  --path PATH        relative path to the current git repository\n  -d, --dry-run      Do not open the url in the brower, and only print to stdout\n  -c, --copy         Copy url to clipboard, if available\n  -s, --sourcegraph  Open objects in sourcegraph\n  -g, --godocs       Open objects in godocs\n  -v, --version      show program's version number and exit\n```\n\n### Examples\n\n| Command                           | Opens                                                                                    |\n|-----------------------------------|------------------------------------------------------------------------------------------|\n| `git browse`                      | <https://github.com/albertyw/git-browse>                                                 |\n| `git browse README.md`            | <https://github.com/albertyw/git-browse/blob/master/README.md>                           |\n| `git browse git_browse`           | <https://github.com/albertyw/git-browse/tree/master/git_browse/>                         |\n| `git browse v1.1.1`               | <https://github.com/albertyw/git-browse/commit/80b219dee0aaa86b378993cbf88511126b813c5f> |\n| `git browse --sourcegraph`        | <https://sourcegraph.com/github.com/albertyw/git-browse>\n| `git browse --godocs`             | <https://godocs.io/github.com/albertyw/git-browse>\n| `git browse` for Bitbucket        | <https://bitbucket.org/albertyw/asdf>\n| `git browse` for Gitlab           | <https://gitlab.com/albertyw/asdf>\n| `git browse` for Uber Phabricator | <https://code.uberinternal.com/diffusion/rASDF/repository/master/>\n\nRelated Projects\n----------------\n\n- [git-brws](https://github.com/rhysd/git-brws)\n- [hub browse](https://hub.github.com/)\n- [git open](https://github.com/paulirish/git-open)\n- [open-browser-github.vim](https://github.com/tyru/open-browser-github.vim)\n\nDevelopment\n-----------\n\n```bash\npip install -e .[test]\nruff check .\nmypy .\ncoverage run -m unittest\ncoverage report\n```\n\nPublishing\n----------\n\n1.  Update changelog and `__version__` variable with a semantic version\n2.  Commit changes, create a version tag, and push both\n3.  Update [albertyw/homebrew-albertyw](https://github.com/albertyw/homebrew-albertyw)\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Open repositories, directories, and files in the browser",
    "version": "2.13.10",
    "project_urls": {
        "Homepage": "https://github.com/albertyw/git-browse"
    },
    "split_keywords": [
        "github",
        " phabricator",
        " repository",
        " browser"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a4098018bbb43b9e25d7f057348a7569f23acf8dc7e511e2e5ec0561218c8505",
                "md5": "a226d28c39223511884dfb042274ce6b",
                "sha256": "dbd1f6d88d8d42cc4ad308ec6820fb06c25837f3c3e452965d195fd91f6d7ab1"
            },
            "downloads": -1,
            "filename": "git_browse-2.13.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a226d28c39223511884dfb042274ce6b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 13122,
            "upload_time": "2024-04-20T05:16:39",
            "upload_time_iso_8601": "2024-04-20T05:16:39.144464Z",
            "url": "https://files.pythonhosted.org/packages/a4/09/8018bbb43b9e25d7f057348a7569f23acf8dc7e511e2e5ec0561218c8505/git_browse-2.13.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "29754f69662be5df1c0b159c5e8565d388d1e71bffe84620e1f5bb0c15001156",
                "md5": "a3d4e674b3663da7f66fd35691961ccd",
                "sha256": "ab69f359df2ee55b10febeef38bd405734d0013c2924e1274c1d20ebcc8c0600"
            },
            "downloads": -1,
            "filename": "git_browse-2.13.10.tar.gz",
            "has_sig": false,
            "md5_digest": "a3d4e674b3663da7f66fd35691961ccd",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 12735,
            "upload_time": "2024-04-20T05:16:41",
            "upload_time_iso_8601": "2024-04-20T05:16:41.015485Z",
            "url": "https://files.pythonhosted.org/packages/29/75/4f69662be5df1c0b159c5e8565d388d1e71bffe84620e1f5bb0c15001156/git_browse-2.13.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-20 05:16:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "albertyw",
    "github_project": "git-browse",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "git-browse"
}
        
Elapsed time: 0.26148s