heartai


Nameheartai JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/ahmetxhero/AhmetX-HeartAi.git
SummaryAI-powered ECG/EKG signal processing and arrhythmia detection library
upload_time2025-09-07 23:31:35
maintainerNone
docs_urlNone
authorAhmetXHero
requires_python>=3.8
licenseMIT License Copyright (c) 2025 AhmetXHero Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords ecg ekg arrhythmia detection machine-learning healthcare biosignal
VCS
bugtrack_url
requirements numpy scipy pandas scikit-learn joblib matplotlib seaborn click rich pydantic
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # HeartAI 🫀

[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
[![Status](https://img.shields.io/badge/status-alpha-orange.svg)](https://github.com/ahmetxhero/heartai)

**heartai** is a Python library designed to process ECG/EKG (electrocardiogram) signals and provide AI-powered predictions for potential arrhythmia risks. It is aimed at researchers, healthcare data scientists, and developers who want to experiment with biosignal processing and lightweight machine learning models in the medical domain.

## 🛠 Features

### 📊 ECG Signal Processing
- Load ECG data from `.csv`, `.txt`, or standard formats
- Apply noise filtering (Butterworth, band-pass, etc.)
- Normalize and segment signals for analysis

### 🤖 AI/ML Prediction
- Pre-trained lightweight ML model for arrhythmia detection
- Binary classification: Normal rhythm vs Potential arrhythmia
- Option to train on custom datasets

### 📈 Visualization Tools
- Plot ECG waveforms (P-QRS-T cycles)
- Highlight detected anomalies

### 🔌 Extensible
- Easy integration with healthcare IoT devices and research pipelines
- Modular design for custom ML models

## 🚀 Quick Start

### Installation

```bash
pip install heartai
```

### Command Line Usage

```bash
# Predict arrhythmia risk from ECG data
heartai predict ecg_data.csv
```

### Python API Usage

```python
from heartai import ECGAnalyzer

# Load and analyze ECG data
analyzer = ECGAnalyzer("ecg_data.csv")
analyzer.preprocess()
prediction = analyzer.predict()

print("Prediction:", prediction)
```

**Output example:**
```
Prediction: Potential arrhythmia detected (confidence: 87%)
```

## 📋 Requirements

- Python 3.8+
- NumPy, SciPy, Pandas
- Scikit-learn
- Matplotlib, Seaborn

## 🎯 Roadmap (2025 Vision)

- [ ] Support for real-time ECG streaming
- [ ] Integration with wearable devices (Apple Watch, Fitbit, etc.)
- [ ] Deep learning models for multi-class arrhythmia classification
- [ ] REST API & FastAPI microservice deployment

## Documentation

For detailed documentation, examples, and API reference, visit our [GitHub repository](https://github.com/ahmetxhero/AhmetX-HeartAi).

## Contributing

We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## ⚠️ Disclaimer

This library is for research and educational purposes only. It is not intended for clinical diagnosis or medical decision-making. Always consult with qualified healthcare professionals for medical advice.

## 📧 Contact

- GitHub: [AhmetX-HeartAi](https://github.com/ahmetxhero/AhmetX-HeartAi)
- Email: ahmetxhero@gmail.com

---

Made with ❤️ for the healthcare research community

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ahmetxhero/AhmetX-HeartAi.git",
    "name": "heartai",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "ecg, ekg, arrhythmia, detection, machine-learning, healthcare, biosignal",
    "author": "AhmetXHero",
    "author_email": "AhmetXHero <ahmetxhero@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/16/db/9036adb82ee86cfa58d5133f6b67b9627feb07c097da03505a433b0ef570/heartai-0.1.0.tar.gz",
    "platform": null,
    "description": "# HeartAI \ud83e\udec0\n\n[![Python](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)\n[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)\n[![Status](https://img.shields.io/badge/status-alpha-orange.svg)](https://github.com/ahmetxhero/heartai)\n\n**heartai** is a Python library designed to process ECG/EKG (electrocardiogram) signals and provide AI-powered predictions for potential arrhythmia risks. It is aimed at researchers, healthcare data scientists, and developers who want to experiment with biosignal processing and lightweight machine learning models in the medical domain.\n\n## \ud83d\udee0 Features\n\n### \ud83d\udcca ECG Signal Processing\n- Load ECG data from `.csv`, `.txt`, or standard formats\n- Apply noise filtering (Butterworth, band-pass, etc.)\n- Normalize and segment signals for analysis\n\n### \ud83e\udd16 AI/ML Prediction\n- Pre-trained lightweight ML model for arrhythmia detection\n- Binary classification: Normal rhythm vs Potential arrhythmia\n- Option to train on custom datasets\n\n### \ud83d\udcc8 Visualization Tools\n- Plot ECG waveforms (P-QRS-T cycles)\n- Highlight detected anomalies\n\n### \ud83d\udd0c Extensible\n- Easy integration with healthcare IoT devices and research pipelines\n- Modular design for custom ML models\n\n## \ud83d\ude80 Quick Start\n\n### Installation\n\n```bash\npip install heartai\n```\n\n### Command Line Usage\n\n```bash\n# Predict arrhythmia risk from ECG data\nheartai predict ecg_data.csv\n```\n\n### Python API Usage\n\n```python\nfrom heartai import ECGAnalyzer\n\n# Load and analyze ECG data\nanalyzer = ECGAnalyzer(\"ecg_data.csv\")\nanalyzer.preprocess()\nprediction = analyzer.predict()\n\nprint(\"Prediction:\", prediction)\n```\n\n**Output example:**\n```\nPrediction: Potential arrhythmia detected (confidence: 87%)\n```\n\n## \ud83d\udccb Requirements\n\n- Python 3.8+\n- NumPy, SciPy, Pandas\n- Scikit-learn\n- Matplotlib, Seaborn\n\n## \ud83c\udfaf Roadmap (2025 Vision)\n\n- [ ] Support for real-time ECG streaming\n- [ ] Integration with wearable devices (Apple Watch, Fitbit, etc.)\n- [ ] Deep learning models for multi-class arrhythmia classification\n- [ ] REST API & FastAPI microservice deployment\n\n## Documentation\n\nFor detailed documentation, examples, and API reference, visit our [GitHub repository](https://github.com/ahmetxhero/AhmetX-HeartAi).\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## \u26a0\ufe0f Disclaimer\n\nThis library is for research and educational purposes only. It is not intended for clinical diagnosis or medical decision-making. Always consult with qualified healthcare professionals for medical advice.\n\n## \ud83d\udce7 Contact\n\n- GitHub: [AhmetX-HeartAi](https://github.com/ahmetxhero/AhmetX-HeartAi)\n- Email: ahmetxhero@gmail.com\n\n---\n\nMade with \u2764\ufe0f for the healthcare research community\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 AhmetXHero\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "AI-powered ECG/EKG signal processing and arrhythmia detection library",
    "version": "0.1.0",
    "project_urls": {
        "Bug Reports": "https://github.com/ahmetxhero/AhmetX-HeartAi/issues",
        "Homepage": "https://github.com/ahmetxhero/AhmetX-HeartAi",
        "Source": "https://github.com/ahmetxhero/AhmetX-HeartAi"
    },
    "split_keywords": [
        "ecg",
        " ekg",
        " arrhythmia",
        " detection",
        " machine-learning",
        " healthcare",
        " biosignal"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9e3f1bb56d154b0dddb4933fe3771f93d047967caedf3a0e979dbe8c1cac9065",
                "md5": "9c18f3b29ff15b91889cda9056e242f5",
                "sha256": "6124b424eb3656bd0eabc29d9d4cff4d6251adf4db1f8b914916848b476a346a"
            },
            "downloads": -1,
            "filename": "heartai-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c18f3b29ff15b91889cda9056e242f5",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 25979,
            "upload_time": "2025-09-07T23:31:34",
            "upload_time_iso_8601": "2025-09-07T23:31:34.133180Z",
            "url": "https://files.pythonhosted.org/packages/9e/3f/1bb56d154b0dddb4933fe3771f93d047967caedf3a0e979dbe8c1cac9065/heartai-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "16db9036adb82ee86cfa58d5133f6b67b9627feb07c097da03505a433b0ef570",
                "md5": "51d2a1f62f564e04e54530fb8b3f0136",
                "sha256": "279ebe7099e7f031cd847fe5d0543f18ad6984b11c7a14f7954e91cb389193bf"
            },
            "downloads": -1,
            "filename": "heartai-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "51d2a1f62f564e04e54530fb8b3f0136",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 36420,
            "upload_time": "2025-09-07T23:31:35",
            "upload_time_iso_8601": "2025-09-07T23:31:35.487099Z",
            "url": "https://files.pythonhosted.org/packages/16/db/9036adb82ee86cfa58d5133f6b67b9627feb07c097da03505a433b0ef570/heartai-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-07 23:31:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ahmetxhero",
    "github_project": "AhmetX-HeartAi",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "numpy",
            "specs": [
                [
                    ">=",
                    "1.21.0"
                ]
            ]
        },
        {
            "name": "scipy",
            "specs": [
                [
                    ">=",
                    "1.7.0"
                ]
            ]
        },
        {
            "name": "pandas",
            "specs": [
                [
                    ">=",
                    "1.3.0"
                ]
            ]
        },
        {
            "name": "scikit-learn",
            "specs": [
                [
                    ">=",
                    "1.0.0"
                ]
            ]
        },
        {
            "name": "joblib",
            "specs": [
                [
                    ">=",
                    "1.1.0"
                ]
            ]
        },
        {
            "name": "matplotlib",
            "specs": [
                [
                    ">=",
                    "3.5.0"
                ]
            ]
        },
        {
            "name": "seaborn",
            "specs": [
                [
                    ">=",
                    "0.11.0"
                ]
            ]
        },
        {
            "name": "click",
            "specs": [
                [
                    ">=",
                    "8.0.0"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    ">=",
                    "12.0.0"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    ">=",
                    "1.8.0"
                ]
            ]
        }
    ],
    "lcname": "heartai"
}
        
Elapsed time: 1.68416s