Merge pull request #129 from tompollard/tp/rm_readme_rst

Switch to README.md for the description on PyPi

.github/workflows/python-package.yml

@@ -5,9 +5,9 @@ name: Python package
 
 on:
   push:
-    branches: [ "master" ]
+    branches: [ "main" ]
   pull_request:
-    branches: [ "master" ]
+    branches: [ "main" ]
 
 jobs:
   build:

MANIFEST.in

@@ -2,4 +2,4 @@
 include LICENSE
 
 # Include readme file
-include README.rst
+include README.md

README.md

@@ -4,7 +4,7 @@ tableone is a package for creating "Table 1" summary statistics for a patient
 population. It was inspired by the R package of the same name by Yoshida and 
 Bohn.
 
-[![Build Status](https://travis-ci.org/tompollard/tableone.svg?branch=master)](https://travis-ci.org/tompollard/tableone) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.837898.svg)](https://doi.org/10.5281/zenodo.837898) [![Documentation Status](https://readthedocs.org/projects/tableone/badge/?version=latest)](https://tableone.readthedocs.io/en/latest/?badge=latest) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/tableone/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge) [![PyPI version](https://badge.fury.io/py/tableone.svg)](https://badge.fury.io/py/tableone)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.837898.svg)](https://doi.org/10.5281/zenodo.837898) [![Documentation Status](https://readthedocs.org/projects/tableone/badge/?version=latest)](https://tableone.readthedocs.io/en/latest/?badge=latest) [![Anaconda-Server Badge](https://anaconda.org/conda-forge/tableone/badges/installer/conda.svg)](https://conda.anaconda.org/conda-forge) [![PyPI version](https://badge.fury.io/py/tableone.svg)](https://badge.fury.io/py/tableone)
 
 ## Suggested citation
 

docs/conf.py

@@ -58,9 +58,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'0.7.10'
+version = u'0.7.11'
 # The full version, including alpha/beta/rc tags.
-release = u'0.7.10'
+release = u'0.7.11'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

setup.py

@@ -1,5 +1,6 @@
 # Always prefer setuptools over distutils
 from setuptools import setup, find_packages
+from pathlib import Path
 
 # To use a consistent encoding
 from codecs import open
@@ -8,19 +9,20 @@
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the README file
-with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
-    long_description = f.read()
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
 
 setup(
     name='tableone',
 
     # Versions should comply with PEP440. For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version='0.7.10',
+    version='0.7.11',
 
     description='TableOne',
     long_description=long_description,
+    long_description_content_type='text/markdown',
 
     # The project's main homepage.
     url='https://github.com/tompollard/tableone',

tableone/__init__.py

@@ -2,4 +2,4 @@
 from .tableone import TableOne, load_dataset, tableone
 
 __author__ = "Tom Pollard <tpollard@mit.edu>, Alistair Johnson, Jesse Raffa"
-__version__ = "0.7.10"
+__version__ = "0.7.11"