Repository: albertyw/git-browse

Issue:
Convert readme from rst to md

Discussion:

Patch:
diff --git a/MANIFEST.in b/MANIFEST.in
index 063cd54..a33db56 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,2 +1,2 @@
-include README.rst
+include README.md
 include CHANGELOG.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..841eef2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,107 @@
+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)
+
+[![Codeship Status for albertyw/git-browse](https://app.codeship.com/projects/fbd67810-b952-0134-2c2e-166255a25182/status?branch=master)](https://app.codeship.com/projects/194945)
+[![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 repositories, 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 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>):
+
+```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] [-s] [-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
+  -s, --sourcegraph  Open objects in sourcegraph
+  -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> |
+
+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 -r requirements-test.txt
+coverage run setup.py test
+coverage report
+flake8
+mypy git_browse/browse.py
+```
+
+Publishing
+----------
+
+```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).
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 378a12a..0000000
--- a/README.rst
+++ /dev/null
@@ -1,128 +0,0 @@
-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
------
-
-::
-
-    $ 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] [-s] [-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
-      -s, --sourcegraph  Open objects in sourcegraph
-      -v, --version      show program's version number and exit
-
-
-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
-
diff --git a/setup.py b/setup.py
index 218be63..60cffc3 100644
--- a/setup.py
+++ b/setup.py
@@ -9,7 +9,7 @@ from git_browse import browse
 
 # Get the long description from the README file
 here = path.abspath(path.dirname(__file__))
-with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
+with open(path.join(here, 'README.md'), encoding='utf-8') as f:
     long_description = f.read()
 
 setup(


Test patch:
diff --git a/git_browse/tests/test.py b/git_browse/tests/test.py
index 3cbfc28..9578999 100644
--- a/git_browse/tests/test.py
+++ b/git_browse/tests/test.py
@@ -45,11 +45,11 @@ class TestGithubHost(unittest.TestCase):
         )
 
     def test_file_url(self) -> None:
-        self.focus_object.identifier = 'README.rst'
+        self.focus_object.identifier = 'README.md'
         url = self.github_host.file_url(self.repository_url, self.focus_object)
         self.assertEqual(
             url,
-            'https://github.com/albertyw/git-browse/blob/master/README.rst'
+            'https://github.com/albertyw/git-browse/blob/master/README.md'
         )
 
     def test_commit_hash_url(self) -> None:
@@ -322,11 +322,11 @@ class TestGetFocusObject(unittest.TestCase):
         self.assertTrue(focus_object.is_directory())
 
     def test_file_focus_object(self) -> None:
-        target = 'README.rst'
+        target = 'README.md'
         focus_object = browse.get_git_object(target, os.getcwd(), self.host)
         self.assertFalse(focus_object.is_root())
         self.assertFalse(focus_object.is_directory())
-        self.assertEqual(focus_object.identifier[-10:], 'README.rst')
+        self.assertEqual(focus_object.identifier[-10:], 'README.md')
 
     def test_directory_focus_object(self) -> None:
         focus_object = browse.get_git_object('.', os.getcwd(), self.host)
@@ -418,10 +418,10 @@ class FullTest(unittest.TestCase):
 
     @patch("git_browse.browse.open_url")
     def test_file(self, mock_open_url: MagicMock) -> None:
-        sys_argv = ['asdf', 'README.rst']
+        sys_argv = ['asdf', 'README.md']
         expected = (
             'https://github.com/albertyw/git-browse/'
-            'blob/master/README.rst'
+            'blob/master/README.md'
         )
         self.check_main(sys_argv, expected, mock_open_url)
 
diff --git a/git_browse/tests/test_git_urls.py b/git_browse/tests/test_git_urls.py
index 1c88a49..13fd3ad 100644
--- a/git_browse/tests/test_git_urls.py
+++ b/git_browse/tests/test_git_urls.py
@@ -38,8 +38,8 @@ GIT_URLS: List[Tuple[str, str, Union[str, List[str]], bool]] = [
     ),
     (
         'git@github.com:albertyw/git-browse',
-        'README.rst',
-        'https://github.com/albertyw/git-browse/blob/master/README.rst',
+        'README.md',
+        'https://github.com/albertyw/git-browse/blob/master/README.md',
         False
     ),
     (
@@ -69,8 +69,8 @@ GIT_URLS: List[Tuple[str, str, Union[str, List[str]], bool]] = [
     ),
     (
         'gitolite@code.uber.internal:a/b',
-        'README.rst',
-        ['arc', 'browse', 'README.rst'],
+        'README.md',
+        ['arc', 'browse', 'README.md'],
         True
     ),
     (
@@ -93,14 +93,14 @@ GIT_URLS: List[Tuple[str, str, Union[str, List[str]], bool]] = [
     ),
     (
         'gitolite@code.uber.internal:a',
-        'README.rst',
-        ['arc', 'browse', 'README.rst'],
+        'README.md',
+        ['arc', 'browse', 'README.md'],
         True
     ),
     (
         'https://code.uber.internal/x/y',
-        'README.rst',
-        ['arc', 'browse', 'README.rst'],
+        'README.md',
+        ['arc', 'browse', 'README.md'],
         True
     ),
 ]