# pulse-eco-ha
![GitHub Workflow Test](https://github.com/mxilievski/pulse-eco-ha/actions/workflows/test.yml/badge.svg)
![GitHub Workflow Build](https://github.com/mxilievski/pulse-eco-ha/actions/workflows/build.yml/badge.svg)
[![PyPI](https://img.shields.io/pypi/v/pulse-eco-ha?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/pulse-eco-ha)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pulse-eco)
[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/ambv/black)
[![GitHub license](https://img.shields.io/github/license/martinkozle/pulse-eco)](https://github.com/mxilievski/pulse-eco-ha/blob/main/LICENSE)
[![pulse.eco logo](https://pulse.eco/img/pulse-logo-horizontal.svg)](https://pulse.eco)
This project is a customized version based on the [Pulse Eco](https://github.com/martinkozle/pulse-eco) project by [Martin Kozle](https://github.com/martinkozle). The original project is a fantastic initiative, and I want to express my gratitude to Martin and the contributors for their hard work.
## Adjusted Version
This repository serves as an adjusted version tailored for use with Home Assistant. Many thanks to the original developers for laying the groundwork. For detailed documentation, credits, and other information about the original Pulse Eco project, please refer to the [original repository](https://github.com/martinkozle/pulse-eco).
Feel free to explore the original project for a comprehensive understanding of its features and functionality.
## Installation
pulse-eco-ha is avialiable on [PyPI](https://pypi.org/project/pulse-eco-ha):
```console
python -m pip install pulse-eco-ha
```
Requires Python version 3.8+.
## Development
### Install Hatch
<https://hatch.pypa.io/latest/install/>
### Create dev environment
Activate a Python 3.8 environment and run:
```console
hatch env create dev
```
### Install pre-commit hooks
```console
hatch run dev:setup
```
### Create .env file
Set auth credentials in `.env` file:
```console
cp .env.example .env
```
### Before committing
This command must pass without errors before committing:
```console
hatch run dev:check
```
Raw data
{
"_id": null,
"home_page": "",
"name": "pulse-eco-ha",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "air,air pollution,air quality index,api,aqi,eco,pollution,pulse,pulse.eco,python,quality,wrapper",
"author": "",
"author_email": "martinkozle <martinkozle@yahoo.com>, mxilievski <mxilievski@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/64/ea/a1480d325e98ab29af9dbebab3ad42e0fd0f0fee39eaefe91870237ff0c3/pulse_eco_ha-0.3.0.tar.gz",
"platform": null,
"description": "# pulse-eco-ha\n\n![GitHub Workflow Test](https://github.com/mxilievski/pulse-eco-ha/actions/workflows/test.yml/badge.svg)\n![GitHub Workflow Build](https://github.com/mxilievski/pulse-eco-ha/actions/workflows/build.yml/badge.svg)\n\n[![PyPI](https://img.shields.io/pypi/v/pulse-eco-ha?logo=pypi&label=PyPI&logoColor=gold)](https://pypi.org/project/pulse-eco-ha)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pulse-eco)\n\n[![types - Mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/ambv/black)\n[![GitHub license](https://img.shields.io/github/license/martinkozle/pulse-eco)](https://github.com/mxilievski/pulse-eco-ha/blob/main/LICENSE)\n\n[![pulse.eco logo](https://pulse.eco/img/pulse-logo-horizontal.svg)](https://pulse.eco)\n\n\nThis project is a customized version based on the [Pulse Eco](https://github.com/martinkozle/pulse-eco) project by [Martin Kozle](https://github.com/martinkozle). The original project is a fantastic initiative, and I want to express my gratitude to Martin and the contributors for their hard work.\n\n## Adjusted Version\n\nThis repository serves as an adjusted version tailored for use with Home Assistant. Many thanks to the original developers for laying the groundwork. For detailed documentation, credits, and other information about the original Pulse Eco project, please refer to the [original repository](https://github.com/martinkozle/pulse-eco).\n\nFeel free to explore the original project for a comprehensive understanding of its features and functionality.\n\n## Installation\n\npulse-eco-ha is avialiable on [PyPI](https://pypi.org/project/pulse-eco-ha):\n\n```console\npython -m pip install pulse-eco-ha\n```\n\nRequires Python version 3.8+.\n\n## Development\n\n### Install Hatch\n\n<https://hatch.pypa.io/latest/install/>\n\n### Create dev environment\n\nActivate a Python 3.8 environment and run:\n\n```console\nhatch env create dev\n```\n\n### Install pre-commit hooks\n\n```console\nhatch run dev:setup\n```\n\n### Create .env file\n\nSet auth credentials in `.env` file:\n\n```console\ncp .env.example .env\n```\n\n### Before committing\n\nThis command must pass without errors before committing:\n\n```console\nhatch run dev:check\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "pulse.eco API wrapper",
"version": "0.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/mxilievski/pulse-eco-ha/issues",
"Homepage": "https://github.com/mxilievski/pulse-eco-ha"
},
"split_keywords": [
"air",
"air pollution",
"air quality index",
"api",
"aqi",
"eco",
"pollution",
"pulse",
"pulse.eco",
"python",
"quality",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a5dfbc98b8640f6e9ea4c04289d17efb21f58bf6284ceb1f896a788967877aa4",
"md5": "223ea1ccb74b1124e06da43db6ba60a0",
"sha256": "e3c8559bb347c1d2ab5f919547feb2b12d2f54a8178ce593a00573bafc1fab80"
},
"downloads": -1,
"filename": "pulse_eco_ha-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "223ea1ccb74b1124e06da43db6ba60a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8840,
"upload_time": "2023-12-26T12:12:03",
"upload_time_iso_8601": "2023-12-26T12:12:03.658014Z",
"url": "https://files.pythonhosted.org/packages/a5/df/bc98b8640f6e9ea4c04289d17efb21f58bf6284ceb1f896a788967877aa4/pulse_eco_ha-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "64eaa1480d325e98ab29af9dbebab3ad42e0fd0f0fee39eaefe91870237ff0c3",
"md5": "6063a1ea041dbf764b235135d7cad847",
"sha256": "262d3baeadbbad1035aa320c825e755657b6b6acd9b5e0e31ffef3b0b836dd58"
},
"downloads": -1,
"filename": "pulse_eco_ha-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "6063a1ea041dbf764b235135d7cad847",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8319,
"upload_time": "2023-12-26T12:12:05",
"upload_time_iso_8601": "2023-12-26T12:12:05.258012Z",
"url": "https://files.pythonhosted.org/packages/64/ea/a1480d325e98ab29af9dbebab3ad42e0fd0f0fee39eaefe91870237ff0c3/pulse_eco_ha-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-26 12:12:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mxilievski",
"github_project": "pulse-eco-ha",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulse-eco-ha"
}