pyheartlib


Namepyheartlib JSON
Version 1.22.0 PyPI version JSON
download
home_pagehttps://github.com/devnums/pyheartlib
SummaryA Python package for processing electrocardiogram signals
upload_time2024-01-27 07:56:24
maintainer
docs_urlNone
authordevnums
requires_python>=3.10,<3.12
licenseAGPL-3.0-only
keywords electrocardiogram ecg
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Pyheartlib

[![Documentation Status](https://readthedocs.org/projects/pyheartlib/badge/?version=latest)](https://pyheartlib.readthedocs.io/en/latest/?badge=latest)
![Workflow](https://github.com/devnums/pyheartlib/actions/workflows/ci-cd-main.yml/badge.svg?branch=main)
[![license-AGPL--3.0](https://img.shields.io/badge/license-AGPL--3.0-faa302)](https://github.com/devnums/pyheartlib/blob/main/LICENSE)
[![OS](https://img.shields.io/badge/os-Linux%20%7C%20macOS%20-yellow)](https://pyheartlib.readthedocs.io/en/latest/getting-started.html#requirements)
![Python Version](https://img.shields.io/pypi/pyversions/pyheartlib)
[![codecov](https://codecov.io/gh/devnums/pyheartlib/branch/main/graph/badge.svg?token=6IB18KL3E9)](https://codecov.io/gh/devnums/pyheartlib)
[![PyPI](https://img.shields.io/pypi/v/pyheartlib?color=blue)](https://pypi.org/project/pyheartlib/)
![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)


`Pyheartlib` is a Python package for processing electrocardiogram (ECG) recordings. This software facilitates working with signals for tasks such as heartbeat detection, heartbeat classification, and arrhythmia classification. Utilizing it, researchers can focus on these tasks without the burden of designing data processing modules. The package transforms original data into processed signal excerpts and their computed features in order to be used for training various machine learning models including advanced deep learning models, which can be trained by taking advantage of Keras and Tensorflow libraries.

## Documentation

Documentation is available at the link below.

[pyheartlib.readthedocs.io](https://pyheartlib.readthedocs.io).

## Requirements

Current version of the package was tested on:

- Ubuntu: 20.04 | 22.04 & Python: 3.10 | 3.11 & Processor: x86_64

- macOS: 12.6.9 | 13.6 & Python: 3.10 | 3.11 & Processor: x86_64

However, it may also be compatible with other systems.

## Installation

The package can be installed with pip:

```bash
$ pip install pyheartlib
```

## Examples

Examples can be found in the [examples section](https://pyheartlib.readthedocs.io/en/latest/examples/examples.html) of the documentation and also in the GitHub repository ([examples](examples/)).

## Contributing

Feedback and contributions are appreciated. TheĀ guidelines for contributing are provided [here](CONTRIBUTING.md).

## Discussions & Support

For any questions, discussions, or problems with this software, please join us on [Discord](https://discord.gg/DQVfR2yWYc). An alternative option is to open a GitHub issue. ([Issues](https://github.com/devnums/pyheartlib/issues), [New issue](https://github.com/devnums/pyheartlib/issues/new))

## License

`Pyheartlib` is released under the [AGPL-3.0](LICENSE) License.


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/devnums/pyheartlib",
    "name": "pyheartlib",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10,<3.12",
    "maintainer_email": "",
    "keywords": "electrocardiogram,ECG",
    "author": "devnums",
    "author_email": "devnums.code@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e4/e6/017b3b9edea2d80f5dec08d8353de4a1d61f4cf8d91ffbc8fa36c62fc9f7/pyheartlib-1.22.0.tar.gz",
    "platform": null,
    "description": "# Pyheartlib\n\n[![Documentation Status](https://readthedocs.org/projects/pyheartlib/badge/?version=latest)](https://pyheartlib.readthedocs.io/en/latest/?badge=latest)\n![Workflow](https://github.com/devnums/pyheartlib/actions/workflows/ci-cd-main.yml/badge.svg?branch=main)\n[![license-AGPL--3.0](https://img.shields.io/badge/license-AGPL--3.0-faa302)](https://github.com/devnums/pyheartlib/blob/main/LICENSE)\n[![OS](https://img.shields.io/badge/os-Linux%20%7C%20macOS%20-yellow)](https://pyheartlib.readthedocs.io/en/latest/getting-started.html#requirements)\n![Python Version](https://img.shields.io/pypi/pyversions/pyheartlib)\n[![codecov](https://codecov.io/gh/devnums/pyheartlib/branch/main/graph/badge.svg?token=6IB18KL3E9)](https://codecov.io/gh/devnums/pyheartlib)\n[![PyPI](https://img.shields.io/pypi/v/pyheartlib?color=blue)](https://pypi.org/project/pyheartlib/)\n![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n\n\n`Pyheartlib` is a Python package for processing electrocardiogram (ECG) recordings. This software facilitates working with signals for tasks such as heartbeat detection, heartbeat classification, and arrhythmia classification. Utilizing it, researchers can focus on these tasks without the burden of designing data processing modules. The package transforms original data into processed signal excerpts and their computed features in order to be used for training various machine learning models including advanced deep learning models, which can be trained by taking advantage of Keras and Tensorflow libraries.\n\n## Documentation\n\nDocumentation is available at the link below.\n\n[pyheartlib.readthedocs.io](https://pyheartlib.readthedocs.io).\n\n## Requirements\n\nCurrent version of the package was tested on:\n\n- Ubuntu: 20.04 | 22.04 & Python: 3.10 | 3.11 & Processor: x86_64\n\n- macOS: 12.6.9 | 13.6 & Python: 3.10 | 3.11 & Processor: x86_64\n\nHowever, it may also be compatible with other systems.\n\n## Installation\n\nThe package can be installed with pip:\n\n```bash\n$ pip install pyheartlib\n```\n\n## Examples\n\nExamples can be found in the [examples section](https://pyheartlib.readthedocs.io/en/latest/examples/examples.html) of the documentation and also in the GitHub repository ([examples](examples/)).\n\n## Contributing\n\nFeedback and contributions are appreciated. The\u00a0guidelines for contributing are provided [here](CONTRIBUTING.md).\n\n## Discussions & Support\n\nFor any questions, discussions, or problems with this software, please join us on [Discord](https://discord.gg/DQVfR2yWYc). An alternative option is to open a GitHub issue. ([Issues](https://github.com/devnums/pyheartlib/issues), [New issue](https://github.com/devnums/pyheartlib/issues/new))\n\n## License\n\n`Pyheartlib` is released under the [AGPL-3.0](LICENSE) License.\n\n",
    "bugtrack_url": null,
    "license": "AGPL-3.0-only",
    "summary": "A Python package for processing electrocardiogram signals",
    "version": "1.22.0",
    "project_urls": {
        "Documentation": "https://pyheartlib.readthedocs.io",
        "Homepage": "https://github.com/devnums/pyheartlib",
        "Repository": "https://github.com/devnums/pyheartlib"
    },
    "split_keywords": [
        "electrocardiogram",
        "ecg"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6d2b574f0e45386e377db5df0e239ba6ec43deafe7d9570ffdc8a6e0c6f9ba28",
                "md5": "662a23e3605fb398cceb6cb5a4c9cd3f",
                "sha256": "67ba004cb4126efad3d2381962e71f3236507b1ad6d788b3cac10091de16661e"
            },
            "downloads": -1,
            "filename": "pyheartlib-1.22.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "662a23e3605fb398cceb6cb5a4c9cd3f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10,<3.12",
            "size": 48774,
            "upload_time": "2024-01-27T07:56:23",
            "upload_time_iso_8601": "2024-01-27T07:56:23.083905Z",
            "url": "https://files.pythonhosted.org/packages/6d/2b/574f0e45386e377db5df0e239ba6ec43deafe7d9570ffdc8a6e0c6f9ba28/pyheartlib-1.22.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e4e6017b3b9edea2d80f5dec08d8353de4a1d61f4cf8d91ffbc8fa36c62fc9f7",
                "md5": "177b7db8de311161fc02dcc63656251a",
                "sha256": "9ae998af0ed83d6cfa4bfc461dc2f663459281bc2258e9490d77aa8bd061cb46"
            },
            "downloads": -1,
            "filename": "pyheartlib-1.22.0.tar.gz",
            "has_sig": false,
            "md5_digest": "177b7db8de311161fc02dcc63656251a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10,<3.12",
            "size": 40383,
            "upload_time": "2024-01-27T07:56:24",
            "upload_time_iso_8601": "2024-01-27T07:56:24.758191Z",
            "url": "https://files.pythonhosted.org/packages/e4/e6/017b3b9edea2d80f5dec08d8353de4a1d61f4cf8d91ffbc8fa36c62fc9f7/pyheartlib-1.22.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-27 07:56:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "devnums",
    "github_project": "pyheartlib",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pyheartlib"
}
        
Elapsed time: 0.17409s