Switch to Poetry for dependency management and package description (#356)

* Add poetry configuration file and update project dependencies

* Update package description and patch version.

* Remove requirements.txt, setup.py, and MANIFEST.in.

* Update GH workflows. Set test Python version matrix to 3.7, 3.8, 3.9.

* Add instructions for developing with Poetry and downloading dependencies

Author: cx1111

.github/workflows/run-tests.yml

@@ -18,7 +18,7 @@ jobs:
     strategy:
       matrix:
         os: [windows-latest, ubuntu-latest, macos-latest]
-        python-version: [3.6, 3.7, 3.8]
+        python-version: ["3.7", "3.8", "3.9"]
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
@@ -27,11 +27,12 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          pip install -r requirements.txt
-      - name: Run nosetests
-        run: |
-          nosetests
+          python -m pip install --upgrade pip poetry
+          pip install ".[dev]"
+      - name: Run tests
+        run: nosetests
+      - name: Validate poetry file
+        run: poetry check
 
   test-deb10-i386:
     runs-on: ubuntu-latest
@@ -55,6 +56,6 @@ jobs:
       # https://github.com/actions/checkout/issues/334
       - uses: actions/checkout@v1
 
-      - name: Run nosetests
+      - name: Run tests
         run: |
           nosetests3

.gitignore

@@ -69,3 +69,6 @@ target/
 
 # OSX .DS_Store
 .DS_Store
+
+# pyenv
+.python-version

MANIFEST.in

@@ -21,30 +21,56 @@ See the [demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/master/demo.ipy
 
 ## Installation
 
-The distribution is hosted on pypi at: <https://pypi.python.org/pypi/wfdb/>. To directly install the package from pypi, run from your terminal::
+The distribution is hosted on PyPI at: <https://pypi.python.org/pypi/wfdb/>. The package can be directly installed from PyPI using either pip or poetry:
 
 ```sh
 pip install wfdb
+poetry add wfdb
 ```
 
 The development version is hosted at: <https://github.com/MIT-LCP/wfdb-python>. This repository also contains demo scripts and example data. To install the development version, clone or download the repository, navigate to the base directory, and run:
 
 ```sh
+# Without dev dependencies
 pip install .
-```
+poetry install
 
-## Development
+# With dev dependencies
+pip install ".[dev]"
+poetry install -E dev
+```
 
-The package is to be expanded with physiological signal-processing tools, and general improvements. Development is made for Python 3.6+ only.
+See the [note](#package-management) below about dev dependencies.
 
-## Contributing
+## Developing
 
 We welcome community contributions in the form of pull requests. When contributing code, please ensure:
 
 - [PEP8](https://www.python.org/dev/peps/pep-0008/) style guidelines are followed.
 - Documentation is provided. New functions and classes should have numpy/scipy style [docstrings](https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt).
 - Unit tests are written for new features that are not covered by [existing tests](https://github.com/MIT-LCP/wfdb-python/tree/master/tests).
 
+### Package Management
+
+This project uses [poetry](https://python-poetry.org/docs/) for package management and distribution.
+
+Development dependencies are specified as optional dependencies, and then added to the "dev" extra group in the [pyproject.toml](./pyproject.toml) file.
+
+```sh
+# Do NOT use: poetry add <somepackage> --dev
+poetry add --optional <somepackage>
+```
+
+The `[tool.poetry.dev-dependencies]` attribute is NOT used because of a [limitation](https://github.com/python-poetry/poetry/issues/3514) that prevents these dependencies from being pip installable. Therefore, dev dependencies are not installed when purely running `poetry install`, and the `--no-dev` flag has no meaning in this project.
+
+Make sure the versions in [version.py](./wfdb/version.py) and [pyproject.toml](./pyproject.toml) are kept in sync.
+
+To upload a new distribution to PyPI:
+
+```sh
+poetry publish
+```
+
 ## Citing
 
 When using this resource, please cite the software [publication](https://physionet.org/content/wfdb-python/) oh PhysioNet.