From 59a3f0623998657c823eff59531e1553b78b9dd3 Mon Sep 17 00:00:00 2001 From: Benjamin Moody Date: Tue, 8 Oct 2024 15:45:41 -0400 Subject: [PATCH 1/2] README: remove confusing comments about poetry. poetry is used as a build tool, but people who want to install and use the package have no need to interact directly with poetry. Moreover, the "poetry install" command doesn't work. Remove comments that suggest otherwise. (If people are already using poetry for reasons of their own, there's nothing stopping them from adding wfdb as a dependency to their own project. In that case, they should know to consult the documentation of the tools they're using.) Also clarify that installing "dev" dependencies is an optional thing for developers, and not a required installation step. --- README.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 564a32d8..53abb2c4 100644 --- a/README.md +++ b/README.md @@ -21,11 +21,10 @@ See the [demo.ipynb](https://github.com/MIT-LCP/wfdb-python/blob/main/demo.ipynb ## Installation -The distribution is hosted on PyPI at: . The package can be directly installed from PyPI using either pip or poetry: +The distribution is hosted on PyPI at: . The package can be directly installed from PyPI using pip: ```sh 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 ). @@ -33,20 +32,15 @@ On Linux systems, accessing _compressed_ WFDB signal files requires installing ` 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: ```sh -# Without dev dependencies pip install . -poetry install +``` -# With dev dependencies -pip install ".[dev]" -poetry install -E dev +If you intend to make changes to the repository, you can install additional packages that are useful for development by running: -# Install the dependencies only -poetry install -E dev --no-root +```sh +pip install ".[dev]" ``` -**See the [note](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md#package-and-dependency-management) about dev dependencies.** - ## Developing Please see the [DEVELOPING.md](https://github.com/MIT-LCP/wfdb-python/blob/main/DEVELOPING.md) document for contribution/development instructions. From 4b231913a20792dac39730a4902fa3d444971c7c Mon Sep 17 00:00:00 2001 From: Benjamin Moody Date: Tue, 8 Oct 2024 15:54:53 -0400 Subject: [PATCH 2/2] README: update comment about libsndfile. The soundfile package nowadays ships binaries for MacOS arm64 as well as for GNU/Linux x86_64 - which should cover most common desktop and cloud environments that people are using. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 53abb2c4..abd5a339 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ The distribution is hosted on PyPI at: . The pip install 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 some less-common systems, you may need to install `libsndfile` separately. See the [soundfile installation notes](https://pypi.org/project/soundfile/) for more information. 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: