Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 3.16 KB

DEVELOPING.md

File metadata and controls

79 lines (51 loc) · 3.16 KB
Raw

Developing WFDB-Python

Guidelines

We welcome community contributions in the form of pull requests. When contributing code, please ensure:

  • Documentation is provided. New functions and classes should have numpy/scipy style docstrings.
  • Unit tests are written for new features that are not covered by existing tests.
  • The code style is consistent with the project's formating standards.

Run the formatter with:

black .

Package and Dependency Management

This project uses poetry for package management and distribution.

Development dependencies are specified as optional dependencies, and then added to the "dev" extra group in the pyproject.toml file.

# Do NOT use: poetry add <somepackage> --dev
poetry add --optional <somepackage>

The [tool.poetry.dev-dependencies] attribute is NOT used because of a limitation 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

Make sure the versions in version.py and 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.

Setup: configure access to repositories:

# Create an API token, then add it
poetry config pypi-token.pypi <my-token>

# For testpypi
poetry config repositories.test-pypi https://test.pypi.org/legacy/
poetry config pypi-token.test-pypi <my-testpypi-token>

To build and upload a new distribution:

poetry build

poetry publish -r test-pypi
poetry publish

Creating Documentation

The project's documentation is generated by Sphinx using the content in the docs directory. The generated content is then hosted on readthedocs (RTD) at: http://wfdb.readthedocs.io

To manage the content on RTD, request yourself to be added to the wfdb project. The project has already been configured to import content from the GitHub repository. Documentation for new releases should be automatically built and uploaded. See the import guide for more details.

There is some redundancy in specifying the Sphinx requirements between pyproject.toml and docs/requirements.txt, the latter of which is used by RTD. Make sure that the content is consistent across the two files.

To generate the HTML content locally, install the required dependencies and run from the docs directory:

make html

Tests

Run tests using pytest:

pytest
# Distribute tests across multiple cores.
# https://github.com/pytest-dev/pytest-xdist
pytest -n auto