| Name | git-browse JSON |
| Version |
2.13.11
JSON |
| download |
| home_page | None |
| Summary | Open repositories, directories, and files in the browser |
| upload_time | 2024-10-29 03:49:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT |
| keywords |
github
phabricator
repository
browser
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Git Browse
==========
[](https://pypi.org/project/git-browse/)
[](https://drone.albertyw.com/albertyw/git-browse)
[](https://codeclimate.com/github/albertyw/git-browse)
[](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).
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/ba/cb/575fc775bb0c1ebedc4cefe26c0a8343486c58cbafef6c39ffea6f667a88/git_browse-2.13.11.tar.gz",
"platform": null,
"description": "Git Browse\n==========\n\n[](https://pypi.org/project/git-browse/)\n\n\n\n[](https://drone.albertyw.com/albertyw/git-browse)\n[](https://codeclimate.com/github/albertyw/git-browse)\n[](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\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.11",
"project_urls": {
"Homepage": "https://github.com/albertyw/git-browse"
},
"split_keywords": [
"github",
" phabricator",
" repository",
" browser"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "150f4b3ea228e3299c4c2d1e8ada4ac6fb99889ba809ba1f2c02245fa783450c",
"md5": "271124f213f815977ca2c6d56c3581f5",
"sha256": "591cac86a6871635225a33383e530957bc883d77020a9114617c95700689fe97"
},
"downloads": -1,
"filename": "git_browse-2.13.11-py3-none-any.whl",
"has_sig": false,
"md5_digest": "271124f213f815977ca2c6d56c3581f5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13108,
"upload_time": "2024-10-29T03:49:31",
"upload_time_iso_8601": "2024-10-29T03:49:31.577042Z",
"url": "https://files.pythonhosted.org/packages/15/0f/4b3ea228e3299c4c2d1e8ada4ac6fb99889ba809ba1f2c02245fa783450c/git_browse-2.13.11-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bacb575fc775bb0c1ebedc4cefe26c0a8343486c58cbafef6c39ffea6f667a88",
"md5": "9096e3e12d92138bd7db3c32d66daae8",
"sha256": "75585bd989658b01c5f4440e987adec03870d77ba3fc070af13a7cfb8bdf2e4f"
},
"downloads": -1,
"filename": "git_browse-2.13.11.tar.gz",
"has_sig": false,
"md5_digest": "9096e3e12d92138bd7db3c32d66daae8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12751,
"upload_time": "2024-10-29T03:49:32",
"upload_time_iso_8601": "2024-10-29T03:49:32.611083Z",
"url": "https://files.pythonhosted.org/packages/ba/cb/575fc775bb0c1ebedc4cefe26c0a8343486c58cbafef6c39ffea6f667a88/git_browse-2.13.11.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 03:49:32",
"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"
}
