Skip to content

Commit 225d2a2

Browse files
authored
Update version to 4.0.0 (#398)
* Add more metadata fields to project metadata * Add upload instructions to README
1 parent a0d8d86 commit 225d2a2

File tree

3 files changed

+28
-13
lines changed

3 files changed

+28
-13
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,6 @@
77
[![PhysioNet Project](https://img.shields.io/badge/DOI-10.13026%2Fegpf--2788-blue)](https://doi.org/10.13026/egpf-2788)
88
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/wfdb.svg)](https://pypi.org/project/wfdb)
99

10-
## v4 Announcement
11-
12-
[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.
13-
14-
- Stable v3 documentation: <https://wfdb.readthedocs.io/en/stable/>
15-
- WIP v4 documentation: <https://wfdb.readthedocs.io/en/latest/>
16-
1710
## Introduction
1811

1912
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
3528
poetry add wfdb
3629
```
3730

38-
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 <https://github.com/bastibe/python-soundfile/issues/310> and <https://github.com/bastibe/python-soundfile/issues/325>).
31+
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 <https://github.com/bastibe/python-soundfile/issues/310> and <https://github.com/bastibe/python-soundfile/issues/325>).
3932

4033
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:
4134

@@ -68,7 +61,7 @@ Run the formatter with:
6861
black .
6962
```
7063

71-
### Package Management
64+
### Package and Dependency Management
7265

7366
This project uses [poetry](https://python-poetry.org/docs/) for package management and distribution.
7467

@@ -81,11 +74,29 @@ poetry add --optional <somepackage>
8174

8275
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.
8376

84-
Make sure the versions in [version.py](./wfdb/version.py) and [pyproject.toml](./pyproject.toml) are kept in sync.
77+
### Creating Distributions
8578

86-
To upload a new distribution to PyPI:
79+
Make sure the versions in [version.py](./wfdb/version.py) and [pyproject.toml](./pyproject.toml) are updated and kept in sync.
80+
81+
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.
82+
83+
Setup: configure access to repositories:
8784

8885
```sh
86+
# Create an API token, then add it
87+
poetry config pypi-token.pypi <my-token>
88+
89+
# For testpypi
90+
poetry config repositories.test-pypi https://test.pypi.org/legacy/
91+
poetry config pypi-token.test-pypi <my-testpypi-token>
92+
```
93+
94+
To build and upload a new distribution:
95+
96+
```sh
97+
poetry build
98+
99+
poetry publish -r test-pypi
89100
poetry publish
90101
```
91102

pyproject.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
[tool.poetry]
22
name = "wfdb"
3-
version = "4.0.0a0"
3+
version = "4.0.0"
44
description = "The WFDB Python package: tools for reading, writing, and processing physiologic signals and annotations."
55
authors = ["The Laboratory for Computational Physiology <[email protected]>"]
6+
readme = "README.md"
7+
homepage = "https://github.com/MIT-LCP/wfdb-python/"
8+
repository = "https://github.com/MIT-LCP/wfdb-python/"
9+
documentation = "https://wfdb.readthedocs.io/"
610
license = "MIT"
711

812
[tool.poetry.dependencies]

wfdb/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = "4.0.0a0"
1+
__version__ = "4.0.0"

0 commit comments

Comments
 (0)