Metadata-Version: 2.1
Name: git-browse
Version: 2.7.1
Summary: Open repositories, directories, and files in the browser
Home-page: https://github.com/albertyw/git-browse
Author: Albert Wang
Author-email: git@albertyw.com
License: MIT
Description: Git Browse
        ==========
        
        |PyPI| |Python Versions|
        
        |Codeship Status for albertyw/git-browse| |Dependency Status| |Code
        Climate| |Test Coverage|
        
        Open repositories, directories, and files in the browser.
        See also, git-reviewers_.
        
        .. image:: https://user-images.githubusercontent.com/3151040/28054498-e7cb0746-65c9-11e7-882e-dbf612f5b075.gif
        
        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 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
        ------------
        
        HomeBrew (preferred for MacOS)
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        If you use Homebrew, you can install git-browse through the
        `homebrew-albertyw tap <https://github.com/albertyw/homebrew-albertyw>`__:
        
        .. code:: 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
        -----
        
        ::
        
            Usage: git browse [-h] [--path PATH] [--dry-run] [target]
        
        If ``[target]`` is omitted, the root repository page will be opened. If
        ``[target]`` is a directory or file, then that object will be opened. If
        ``[target]`` is a commit hash, then that commit hash will be opened. If
        ``--path`` is available, then its value is be used to compute the
        relative path to the current git repository If ``--dry-run`` is set,
        then git-browse will only print out the target url instead of opening it
        in a browser
        
        Examples
        ~~~~~~~~
        
        +----------------------------+----------------------------------------------------------------------------------------+
        | Command                    | Opens                                                                                  |
        +============================+========================================================================================+
        | ``git browse``             | https://github.com/albertyw/git-browse                                                 |
        +----------------------------+----------------------------------------------------------------------------------------+
        | ``git browse README.rst``  | https://github.com/albertyw/git-browse/blob/master/README.rst                          |
        +----------------------------+----------------------------------------------------------------------------------------+
        | ``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 |
        +----------------------------+----------------------------------------------------------------------------------------+
        
        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
        -----------
        
        .. code:: bash
        
            pip install -r requirements-test.txt
            coverage run setup.py test
            coverage report
            flake8
            mypy git_browse/browse.py
        
        Publishing
        ----------
        
        .. code:: bash
        
            pip install twine
            python setup.py sdist bdist_wheel
            twine upload dist/*
        
        Need to also update `albertyw/homebrew-albertyw <https://github.com/albertyw/homebrew-albertyw>`_
        
        .. _git-reviewers: https://github.com/albertyw/git-reviewers
        
        .. |PyPI| image:: https://img.shields.io/pypi/v/git-browse.svg
           :target: https://pypi.python.org/pypi/git-browse/
        .. |Python Versions| image:: https://img.shields.io/pypi/pyversions/git-browse.svg
           :target: https://github.com/albertyw/git-browse
        .. |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://pyup.io/repos/github/albertyw/git-browse/shield.svg
           :target: https://pyup.io/repos/github/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
        
        
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
Classifier: Programming Language :: Python :: 3.7
Provides-Extra: test
Provides-Extra: dev
