Merge pull request #62 from satzbeleg/dev

Maintenance Q2-2021

.github/FUNDING.yml

@@ -1,2 +1,4 @@
 github: [ulf1]
-issuehunt: satzbeleg/bwsample
+patreon: ulfhamster
+ko_fi: ulfhamster
+

CHANGES.md

@@ -1,3 +1,7 @@
+# 0.6.4 / 2021-04-08
+
+  * PyPi RST format description
+
 # 0.6.3 / 2021-04-01
 
   * Hoaglin's Approximation for p-value based metric

README.md

@@ -13,7 +13,7 @@ The package `bwsample` addresses three areas:
 ## Installation
 The `bwsample` [git repo](http://github.com/satzbeleg/bwsample) is available as [PyPi package](https://pypi.org/project/bwsample)
 
-```
+```sh
 pip install bwsample>=0.6.3
 ```
 
@@ -169,7 +169,7 @@ The implementations `ratio`, `pvalue`, `'btl'`, `'eigen'`, and `'trans'` are ful
 ### Install a virtual environment
 In order to run the Jupyter notebooks or want to work on this project (e.g. unit tests, syntax checks) you should install a Python virtual environment.
 
-```
+```sh
 python3.6 -m venv .venv
 source .venv/bin/activate
 pip install --upgrade pip
@@ -189,7 +189,7 @@ pip install -r requirements-demo.txt --no-cache-dir
 
 ### Clean up 
 
-```
+```sh
 find . -type f -name "*.pyc" | xargs rm
 find . -type d -name "__pycache__" | xargs rm -r
 rm -r .pytest_cache

bwsample/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.6.3'
+__version__ = '0.6.4'
 
 from .sampling import sample
 from .counting import count

requirements-dev.txt

@@ -2,3 +2,5 @@
 flake8>=3.8.4
 pytest>=6.2.1
 twine==3.3.0
+pypandoc>=1.5
+wheel>=0.31.0

requirements.txt

@@ -1,4 +1,4 @@
 # public packages (see setup.py)
-numpy>=1.19.5
-scipy>=1.5.4
+numpy>=1.19.5,<2
+scipy>=1.5.4,<2
 scikit-learn>=0.24.1

setup.py

@@ -1,9 +1,5 @@
 from setuptools import setup
-
-
-def read(fname):
-    import os
-    return open(os.path.join(os.path.dirname(__file__), fname)).read()
+import pypandoc
 
 
 def get_version(path):
@@ -19,8 +15,7 @@ def get_version(path):
 setup(name='bwsample',
       version=get_version("bwsample/__init__.py"),
       description='Sampling algorithm for best-worst scaling sets.',
-      # long_description=read('README.md'),
-      # long_description_content_type='text/markdown',
+      long_description=pypandoc.convert('README.md', 'rst'),
       url='http://github.com/ulf1/bwsample',
       author='Ulf Hamster',
       author_email='554c46@gmail.com',