Use Markdown readme and add project urls (#172)

* Use `Markdown` readme and add project urls

* Replace `pypi.python.org` links with `pypi.org`

* Use `twine` to upload distributions in `Makefile` [ci skip]

Author: Martin Larralde

.coveragerc

@@ -4,7 +4,8 @@ readme:
 
 .PHONY: release
 release: readme
-	python setup.py sdist bdist_wheel upload
+	python setup.py sdist bdist_wheel
+	twine upload dist/*.whl dist/*.tar.gz
 
 .PHONY: test
 test:

Makefile

@@ -4,7 +4,7 @@ PyFilesystem2
 Python's Filesystem abstraction layer.
 
 [![PyPI version](https://badge.fury.io/py/fs.svg)](https://badge.fury.io/py/fs)
-[![PyPI](https://img.shields.io/pypi/pyversions/fs.svg)](https://pypi.python.org/pypi/fs/)
+[![PyPI](https://img.shields.io/pypi/pyversions/fs.svg)](https://pypi.org/project/fs/)
 [![Build Status](https://travis-ci.org/PyFilesystem/pyfilesystem2.svg?branch=master)](https://travis-ci.org/PyFilesystem/pyfilesystem2)
 [![Coverage Status](https://coveralls.io/repos/github/PyFilesystem/pyfilesystem2/badge.svg)](https://coveralls.io/github/PyFilesystem/pyfilesystem2)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/30ad6445427349218425d93886ade9ee)](https://www.codacy.com/app/will-mcgugan/pyfilesystem2?utm_source=github.com&utm_medium=referral&utm_content=PyFilesystem/pyfilesystem2&utm_campaign=Badge_Grade)

readme.md README.mdreadme.md renamed to README.md

@@ -5,7 +5,7 @@
 subclasses of `~fs.osfs.OSFS`.
 
 """
-# Thanks to authors of https://pypi.python.org/pypi/appdirs
+# Thanks to authors of https://pypi.org/project/appdirs
 
 # see http://technet.microsoft.com/en-us/library/cc766489(WS.10).aspx
 

README.rst

@@ -3,19 +3,19 @@ universal = 1
 
 [metadata]
 license_file = LICENSE
+long_description = file: README.md
+long_description_content_type = text/markdown
+project_urls =
+    Bug Reports = https://github.com/PyFilesystem/pyfilesystem2/issues
+    Documentation = https://pyfilesystem2.readthedocs.io/en/latest/
+    Wiki = https://www.pyfilesystem.org/
 
 [pydocstyle]
 inherit = false
 ignore = D102,D105,D200,D203,D213,D406,D407
 match-dir = (?!tests)(?!docs)[^\.].*
 match = (?!test)(?!setup)[^\._].*\.py
 
-[coverage:report]
-show_missing = true
-exclude_lines =
-        pragma: no cover
-        typing.TYPE_CHECKING
-
 [mypy]
 ignore_missing_imports = true
 
@@ -32,3 +32,14 @@ warn_return_any = false
 
 [mypy-fs.test]
 disallow_untyped_defs = false
+
+[coverage:run]
+omit = fs/test.py
+
+[coverage:report]
+show_missing = true
+exclude_lines =
+    pragma: no cover
+    if False:
+    @typing.overload
+

fs/appfs.py

@@ -19,9 +19,6 @@
     'Topic :: System :: Filesystems',
 ]
 
-with open('README.rst', 'rt') as f:
-    DESCRIPTION = f.read()
-
 REQUIREMENTS = [
     "appdirs~=1.4.3",
     "pytz",
@@ -58,7 +55,6 @@
         'userlog = fs.opener.appfs:AppFSOpener',
     ]},
     license="MIT",
-    long_description=DESCRIPTION,
     name='fs',
     packages=find_packages(exclude=("tests",)),
     platforms=['any'],