From a76d32e75cdb8ad1ce1a6dfb6dce98e9300be60c Mon Sep 17 00:00:00 2001 From: Chen Xie Date: Fri, 24 Jun 2022 14:59:48 -0700 Subject: [PATCH 1/5] Remove v4 note --- README.md | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/README.md b/README.md index 350c9eb1..fca2131f 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,6 @@ [![PhysioNet Project](https://img.shields.io/badge/DOI-10.13026%2Fegpf--2788-blue)](https://doi.org/10.13026/egpf-2788) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/wfdb.svg)](https://pypi.org/project/wfdb) -## v4 Announcement - -[Major breaking changes](https://github.com/MIT-LCP/wfdb-python/issues/369) are planned for WFDB v4, in the core APIs, and the installation method. The planned release date is in August 2022. - -- Stable v3 documentation: -- WIP v4 documentation: - ## Introduction A Python-native package for reading, writing, processing, and plotting physiologic signal and annotation data. The core I/O functionality is based on the Waveform Database (WFDB) [specifications](https://github.com/wfdb/wfdb-spec/). @@ -35,7 +28,7 @@ pip install wfdb poetry add wfdb ``` -On Linux systems, accessing *compressed* WFDB signal files requires installing `libsndfile`, by running `sudo apt-get install libsndfile1` or `sudo yum install libsndfile`. Support for Apple M1 systems is a work in progess (see and ). +On Linux systems, accessing _compressed_ WFDB signal files requires installing `libsndfile`, by running `sudo apt-get install libsndfile1` or `sudo yum install libsndfile`. Support for Apple M1 systems is a work in progess (see and ). The development version is hosted at: . 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: From 1ac54032a53be1847851933a69521acf2ce860e0 Mon Sep 17 00:00:00 2001 From: Chen Xie Date: Fri, 24 Jun 2022 15:08:57 -0700 Subject: [PATCH 2/5] Update version to 4.0.0 --- pyproject.toml | 2 +- wfdb/version.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 60554802..2dd60eb9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "wfdb" -version = "4.0.0a0" +version = "4.0.0" description = "The WFDB Python package: tools for reading, writing, and processing physiologic signals and annotations." authors = ["The Laboratory for Computational Physiology "] license = "MIT" diff --git a/wfdb/version.py b/wfdb/version.py index 7870304a..ce1305bf 100644 --- a/wfdb/version.py +++ b/wfdb/version.py @@ -1 +1 @@ -__version__ = "4.0.0a0" +__version__ = "4.0.0" From 05ebe9901240775b2b6a4cbe266f88fb6a8b9d7e Mon Sep 17 00:00:00 2001 From: Chen Xie Date: Fri, 24 Jun 2022 16:12:08 -0700 Subject: [PATCH 3/5] Add more metadata fields --- pyproject.toml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 2dd60eb9..57b95d2b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,6 +3,10 @@ name = "wfdb" version = "4.0.0" description = "The WFDB Python package: tools for reading, writing, and processing physiologic signals and annotations." authors = ["The Laboratory for Computational Physiology "] +readme = "README.md" +homepage = "https://github.com/MIT-LCP/wfdb-python/" +repository = "https://github.com/MIT-LCP/wfdb-python/" +documentation = "https://wfdb.readthedocs.io/" license = "MIT" [tool.poetry.dependencies] From 27901a412c925401c78b38723fdcd54669449743 Mon Sep 17 00:00:00 2001 From: Chen Xie Date: Fri, 24 Jun 2022 17:11:53 -0700 Subject: [PATCH 4/5] Add upload instructions --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fca2131f..9717e332 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,8 @@ black . This project uses [poetry](https://python-poetry.org/docs/) for package management and distribution. +#### Managing Dependencies + Development dependencies are specified as optional dependencies, and then added to the "dev" extra group in the [pyproject.toml](./pyproject.toml) file. ```sh @@ -74,11 +76,29 @@ poetry add --optional 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. +#### Creating Distributions + +Make sure the versions in [version.py](./wfdb/version.py) and [pyproject.toml](./pyproject.toml) are updated and kept in sync. + +It may be useful to publish to testpypi and preview the changes before publishing to PyPi. However, the project dependencies likely will not be available when trying to install from there. -To upload a new distribution to PyPI: +Setup: configure access to repositories: ```sh +# Create an API token, then add it +poetry config pypi-token.pypi + +# For testpypi +poetry config repositories.test-pypi https://test.pypi.org/legacy/ +poetry config pypi-token.test-pypi +``` + +To build and upload a new distribution: + +```sh +poetry build + +poetry publish -r test-pypi poetry publish ``` From d1028677d5109f074735a0949b1a49e9df7f319b Mon Sep 17 00:00:00 2001 From: Chen Xie Date: Fri, 24 Jun 2022 17:13:53 -0700 Subject: [PATCH 5/5] Change headings --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9717e332..2195b54e 100644 --- a/README.md +++ b/README.md @@ -61,12 +61,10 @@ Run the formatter with: black . ``` -### Package Management +### Package and Dependency Management This project uses [poetry](https://python-poetry.org/docs/) for package management and distribution. -#### Managing Dependencies - Development dependencies are specified as optional dependencies, and then added to the "dev" extra group in the [pyproject.toml](./pyproject.toml) file. ```sh @@ -76,7 +74,7 @@ poetry add --optional 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. -#### Creating Distributions +### Creating Distributions Make sure the versions in [version.py](./wfdb/version.py) and [pyproject.toml](./pyproject.toml) are updated and kept in sync.