Open repositories, directories, and files in the browser
Project description
Git Browse
==========
[![PyPI](https://img.shields.io/pypi/v/git-browse.svg)](https://github.com/albertyw/git-browse)
[![PyPI](https://img.shields.io/pypi/pyversions/git-browse.svg)]()
[ ![Codeship Status for albertyw/git-browse](https://codeship.com/projects/fbd67810-b952-0134-2c2e-166255a25182/status?branch=master)](https://codeship.com/projects/194945)
[![Dependency Status](https://gemnasium.com/badges/github.com/albertyw/git-browse.svg)](https://gemnasium.com/github.com/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 repositories, directories, and files in the browser
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] (https://github.com/phacility/arcanist)
[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.
If you're looking to browse different github repositories, you might like
[hub browse](https://github.com/github/hub/blob/master/commands/browse.go).
Installation
------------
You need to first clone this repository somewhere on your system (perhaps in
your [dotfiles](https://github.com/albertyw/dotfiles)) repository.
```bash
git clone git@github.com:albertyw/git-browse $REPOSITORY_LOCATION
git config --global \
alias.browse \
"!"$REPOSITORY_LOCATION"/git_browse/browse.py --path=\${GIT_PREFIX:-./}"
```
Usage
-----
```
Usage: git browse [object]
```
If `[object]` is omitted, the root repository page will be opened.
If `[object]` is a directory or file, then that object will be opened.
If `[object]` is a commit hash, then that commit hash will be opened.
### 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 |
Development
-----------
```bash
pip install -r requirements-test.txt
coverage run setup.py test
coverage report
flake8
```
Publishing
----------
```bash
sudo apt-get install pandoc
pip install twine pypandoc
python setup.py sdist bdist_wheel
twine upload dist/*
```
==========
[![PyPI](https://img.shields.io/pypi/v/git-browse.svg)](https://github.com/albertyw/git-browse)
[![PyPI](https://img.shields.io/pypi/pyversions/git-browse.svg)]()
[ ![Codeship Status for albertyw/git-browse](https://codeship.com/projects/fbd67810-b952-0134-2c2e-166255a25182/status?branch=master)](https://codeship.com/projects/194945)
[![Dependency Status](https://gemnasium.com/badges/github.com/albertyw/git-browse.svg)](https://gemnasium.com/github.com/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 repositories, directories, and files in the browser
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] (https://github.com/phacility/arcanist)
[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.
If you're looking to browse different github repositories, you might like
[hub browse](https://github.com/github/hub/blob/master/commands/browse.go).
Installation
------------
You need to first clone this repository somewhere on your system (perhaps in
your [dotfiles](https://github.com/albertyw/dotfiles)) repository.
```bash
git clone git@github.com:albertyw/git-browse $REPOSITORY_LOCATION
git config --global \
alias.browse \
"!"$REPOSITORY_LOCATION"/git_browse/browse.py --path=\${GIT_PREFIX:-./}"
```
Usage
-----
```
Usage: git browse [object]
```
If `[object]` is omitted, the root repository page will be opened.
If `[object]` is a directory or file, then that object will be opened.
If `[object]` is a commit hash, then that commit hash will be opened.
### 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 |
Development
-----------
```bash
pip install -r requirements-test.txt
coverage run setup.py test
coverage report
flake8
```
Publishing
----------
```bash
sudo apt-get install pandoc
pip install twine pypandoc
python setup.py sdist bdist_wheel
twine upload dist/*
```
Project details
Release history Release notifications | RSS feed
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.3.1.tar.gz
(5.6 kB
view details)
Built Distribution
File details
Details for the file git-browse-2.3.1.tar.gz
.
File metadata
- Download URL: git-browse-2.3.1.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 771f9c747cb6b7522b32a9693fc6d1ca2285012cc346cdb5eb7647ae37094684 |
|
MD5 | 61d43feb0b60691fc2a40afd7d09162a |
|
BLAKE2b-256 | b5d6f1820bc504bdd9c1fdcdef4d3cb697ead51e7db76650e9a491868c7c123a |
File details
Details for the file git_browse-2.3.1-py2-none-any.whl
.
File metadata
- Download URL: git_browse-2.3.1-py2-none-any.whl
- Upload date:
- Size: 7.1 kB
- Tags: Python 2
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb90ef8435acc39804e351326f8201dc0cf3f5097db43933c7f06667ce9a6826 |
|
MD5 | 18d561f77f273abe5a0900c932b0f680 |
|
BLAKE2b-256 | f3eda539cd8055ebd9bfbdd294e6820e7090aaaabce471ed38a445944aa43b21 |