Metadata-Version: 2.0
Name: git-browse
Version: 2.3.0
Summary: Open repositories, directories, and files in the browser
Home-page: https://github.com/albertyw/git-browse
Author: Albert Wang
Author-email: aywang31@gmail.com
License: MIT
Keywords: github phabricator repository browser
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Topic :: Software Development :: Version Control
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Provides-Extra: dev
Provides-Extra: test

Git Browse
==========

|PyPI| |PyPI|

|Codeship Status for albertyw/git-browse| |Dependency Status| |Code
Climate| |Test 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.

.. code:: 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.c |
|                            | om/alber |
|                            | tyw/git- |
|                            | browse   |
+----------------------------+----------+
| ``git browse README.md``   | https:// |
|                            | github.c |
|                            | om/alber |
|                            | tyw/git- |
|                            | browse/b |
|                            | lob/mast |
|                            | er/READM |
|                            | E.md     |
+----------------------------+----------+
| ``git browse git_browse``  | https:// |
|                            | github.c |
|                            | om/alber |
|                            | tyw/git- |
|                            | browse/t |
|                            | ree/mast |
|                            | er/git\_ |
|                            | browse/  |
+----------------------------+----------+
| ``git browse v1.1.1``      | https:// |
|                            | github.c |
|                            | om/alber |
|                            | tyw/git- |
|                            | browse/c |
|                            | ommit/80 |
|                            | b219dee0 |
|                            | aaa86b37 |
|                            | 8993cbf8 |
|                            | 8511126b |
|                            | 813c5f   |
+----------------------------+----------+

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

.. code:: bash

    pip install -r requirements-test.txt
    coverage run setup.py test
    coverage report
    flake8

Publishing
----------

.. code:: bash

    sudo apt-get install pandoc
    pip install twine pypandoc
    python setup.py sdist bdist_wheel
    twine upload dist/*

.. |PyPI| image:: https://img.shields.io/pypi/v/git-browse.svg
   :target: https://github.com/albertyw/git-browse
.. |PyPI| image:: https://img.shields.io/pypi/pyversions/git-browse.svg
   :target: 
.. |Codeship Status for albertyw/git-browse| image:: https://codeship.com/projects/fbd67810-b952-0134-2c2e-166255a25182/status?branch=master
   :target: https://codeship.com/projects/194945
.. |Dependency Status| image:: https://gemnasium.com/badges/github.com/albertyw/git-browse.svg
   :target: https://gemnasium.com/github.com/albertyw/git-browse
.. |Code Climate| image:: https://codeclimate.com/github/albertyw/git-browse/badges/gpa.svg
   :target: https://codeclimate.com/github/albertyw/git-browse
.. |Test Coverage| image:: https://codeclimate.com/github/albertyw/git-browse/badges/coverage.svg
   :target: https://codeclimate.com/github/albertyw/git-browse/coverage


