Merge pull request #161 from prjemian/138-markdown-README

refactor README

MANIFEST.in

@@ -1,4 +1,4 @@
-include README.rst
+include README.md
 include punx/LICENSE.txt
 include punx/cache/*
 include punx/cache/*/__github_info__.json

README.md

@@ -0,0 +1,33 @@
+# punx - Python Utilities for NeXus HDF5 files
+
+[![image](https://img.shields.io/github/release/prjemian/punx.svg)](https://github.com/prjemian/punx/releases)
+[![image](https://img.shields.io/github/tag/prjemian/punx.svg)](https://github.com/prjemian/punx/tags)
+[![Build Status](https://img.shields.io/github/workflow/status/prjemian/punx/Unit%20Tests)](https://github.com/prjemian/punx/actions?query=workflow%3A%22Unit+Tests%22+branch%3Amain)
+[![PyPI](https://img.shields.io/pypi/v/punx.svg)](https://pypi.python.org/pypi/punx)
+[![conda-forge](https://img.shields.io/conda/vn/conda-forge/punx)](https://anaconda.org/conda-forge/punx)
+
+## [Documentation](http://punx.readthedocs.io)
+
+The *punx* package provides these features:
+
+- Validate NeXus HDF5 data files
+- Choose the NeXus [release](https://github.com/nexusformat/definitions/releases) to use for validation
+- Validate NeXus NXDL files
+- Display NeXus HDF5 data file structure
+- Display NeXus class hierarchy (stretch goal, graphical output)
+
+
+## Package Details
+
+- author:   Pete R. Jemian
+- email:   <[email protected]>
+- copyright:   2014-2021, Pete R. Jemian
+- license:   Creative Commons Attribution 4.0 International Public License (see [LICENSE.txt](punx/LICENSE.txt))
+- URL:   <https://punx.readthedocs.io>
+- git:   <https://github.com/prjemian/punx>
+- issues:   <https://github.com/prjemian/punx/issues>
+- citation:   [![DOI: 10.5281/zenodo.1471686](https://zenodo.org/badge/DOI/10.5281/zenodo.1471686.svg)](https://doi.org/10.5281/zenodo.1471686)
+- static code analyses:
+  [![Code Coverage](https://coveralls.io/repos/github/prjemian/punx/badge.svg?branch=master)](https://coveralls.io/github/prjemian/punx?branch=master)
+  [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/prjemian/punx.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/prjemian/punx/context:python)
+  [![Total alerts](https://img.shields.io/lgtm/alerts/g/prjemian/punx.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/prjemian/punx/alerts/)

punx/__init__.py

@@ -48,6 +48,17 @@
 __download_url__ = u"https://github.com/prjemian/punx/archive/master.zip"
 __keywords__ = ["NeXus", "HDF5"]
 
+__long_description__ = f"""
+{__package_name__}: {__description__}
+
+* home: {__url__}
+* GitHub: {__download_url__}
+* PyPI: https://pypi.python.org/pypi/punx/
+* Conda: https://anaconda.org/conda-forge/punx
+* Copyright: {__copyright__}
+* email: {__email__}
+""".strip()
+
 # used by QSettings to store configuration and user cache
 __settings_organization__ = __package_name__
 __settings_package__ = __package_name__

setup.cfg

@@ -1,5 +1,5 @@
 [metadata]
-description-file = README.rst
+description_file = README.md
 
 [bdist_wheel]
 universal=1

setup.py

@@ -12,16 +12,13 @@
 # -----------------------------------------------------------------------------
 
 from setuptools import setup
-import os
 import versioneer
 
 # pull in some definitions from the package's __init__.py file
 import punx
 
 
 verbose = 1
-README = os.path.join(os.path.dirname(__file__), "README.rst")
-long_description = open(README, "r").read()
 
 
 setup(
@@ -30,7 +27,7 @@
     version=versioneer.get_version(),
     cmdclass=versioneer.get_cmdclass(),
     description=punx.__description__,
-    long_description=long_description,
+    long_description=punx.__long_description__,
     author=punx.__author_name__,
     author_email=punx.__author_email__,
     url=punx.__url__,