# pulse-eco
[](https://codecov.io/gh/martinkozle/pulse-eco)
[](https://pypi.org/project/pulse-eco)
[](https://github.com/astral-sh/ruff)
[](https://github.com/ambv/black)
[](https://github.com/martinkozle/pulse-eco/blob/main/LICENSE)
[](https://pulse.eco)
pulse.eco client for Python.
## Installation
Requires Python version 3.8+.
The `pulse-eco` package comes with no base dependencies, everything is an extra. A sensible default is:
```console
python -m pip install pulse-eco[client,httpx]
```
### List of extras
- `client` - includes Pydantic, used for the higher level validated client (`pulseeco.client`).
- `requests` - includes [requests](https://requests.readthedocs.io/en/latest/) HTTP client with sync support.
- `aiohttp` - includes [aiohttp](https://docs.aiohttp.org/en/stable/) HTTP client with async support.
- `httpx` - includes [HTTPX](https://www.python-httpx.org/) HTTP client with both sync and async support.
## Documentation
API Reference and User Guide for this package is available on [GitHub Pages](https://martinkozle.github.io/pulse-eco/).
Official pulse.eco REST API documentation can be found on [pulse.eco/restapi](https://pulse.eco/restapi).
## Requesting data with a larger time range
The pulse.eco API limits the maximum time span of data you can get from one request.
For `/dataRaw` it is one week, while for `/avgData` it is one year.
If the time range is larger than the maximum, the pulse-eco Python client performs multiple requests to the API and then joins the data together. Be aware of this.
## 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
```
To delete the environment, run:
```console
hatch env remove 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
```
### Docs
To preview the docs locally, run:
```console
hatch run dev:docs-serve
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pulse-eco",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "air, air pollution, air quality index, api, aqi, eco, pollution, pulse, pulse.eco, python, quality, wrapper",
"author": null,
"author_email": "martinkozle <martinkozle@yahoo.com>",
"download_url": "https://files.pythonhosted.org/packages/71/79/0f5ab74ee77527bfdb557c40fa21f59facef618a5b643cf83063c5079ac3/pulse_eco-2.3.0.tar.gz",
"platform": null,
"description": "# pulse-eco\n\n\n[](https://codecov.io/gh/martinkozle/pulse-eco)\n\n\n[](https://pypi.org/project/pulse-eco)\n\n\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/ambv/black)\n[](https://github.com/martinkozle/pulse-eco/blob/main/LICENSE)\n\n[](https://pulse.eco)\n\npulse.eco client for Python.\n\n## Installation\n\nRequires Python version 3.8+.\n\nThe `pulse-eco` package comes with no base dependencies, everything is an extra. A sensible default is:\n\n```console\npython -m pip install pulse-eco[client,httpx]\n```\n\n### List of extras\n\n- `client` - includes Pydantic, used for the higher level validated client (`pulseeco.client`).\n- `requests` - includes [requests](https://requests.readthedocs.io/en/latest/) HTTP client with sync support.\n- `aiohttp` - includes [aiohttp](https://docs.aiohttp.org/en/stable/) HTTP client with async support.\n- `httpx` - includes [HTTPX](https://www.python-httpx.org/) HTTP client with both sync and async support.\n\n## Documentation\n\nAPI Reference and User Guide for this package is available on [GitHub Pages](https://martinkozle.github.io/pulse-eco/).\n\nOfficial pulse.eco REST API documentation can be found on [pulse.eco/restapi](https://pulse.eco/restapi).\n\n## Requesting data with a larger time range\n\nThe pulse.eco API limits the maximum time span of data you can get from one request.\nFor `/dataRaw` it is one week, while for `/avgData` it is one year.\n\nIf the time range is larger than the maximum, the pulse-eco Python client performs multiple requests to the API and then joins the data together. Be aware of this.\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\nTo delete the environment, run:\n\n```console\nhatch env remove 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\n### Docs\n\nTo preview the docs locally, run:\n\n```console\nhatch run dev:docs-serve\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "pulse.eco API wrapper",
"version": "2.3.0",
"project_urls": {
"Bug Tracker": "https://github.com/martinkozle/pulse-eco/issues",
"Homepage": "https://github.com/martinkozle/pulse-eco"
},
"split_keywords": [
"air",
" air pollution",
" air quality index",
" api",
" aqi",
" eco",
" pollution",
" pulse",
" pulse.eco",
" python",
" quality",
" wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a342fa4857400930bbc5d9e07c47104de577e457b96b6fa909ded6541273b80e",
"md5": "f8bb4998b2b2973866d1090014a48a2c",
"sha256": "ff99026b9a807027274ef375cdec655a7ee988b6e88f93edef73af35d0b414ab"
},
"downloads": -1,
"filename": "pulse_eco-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f8bb4998b2b2973866d1090014a48a2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 15223,
"upload_time": "2024-03-27T23:22:15",
"upload_time_iso_8601": "2024-03-27T23:22:15.241476Z",
"url": "https://files.pythonhosted.org/packages/a3/42/fa4857400930bbc5d9e07c47104de577e457b96b6fa909ded6541273b80e/pulse_eco-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71790f5ab74ee77527bfdb557c40fa21f59facef618a5b643cf83063c5079ac3",
"md5": "98b09c55e868b618d14e314132695179",
"sha256": "2b55ddf86f2afe819e422191ae57a3e1c383ec3122c3d351422cd647cc548d86"
},
"downloads": -1,
"filename": "pulse_eco-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "98b09c55e868b618d14e314132695179",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11859,
"upload_time": "2024-03-27T23:22:17",
"upload_time_iso_8601": "2024-03-27T23:22:17.043462Z",
"url": "https://files.pythonhosted.org/packages/71/79/0f5ab74ee77527bfdb557c40fa21f59facef618a5b643cf83063c5079ac3/pulse_eco-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-27 23:22:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "martinkozle",
"github_project": "pulse-eco",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulse-eco"
}
JSON
