 [](https://codecov.io/gh/MideTechnology/endaq-python)
# `endaq-python`: A comprehensive, user-centric Python API for working with enDAQ data and devices
## Installation
endaq is available on PYPI via `pip`:
pip install endaq
For the most recent features that are still under development, you can also use `pip` to install endaq directly from GitHub:
pip install git+https://github.com/MideTechnology/endaq-python.git@development
## Contents
This package consists of several submodules, you can read more about how these are used in their respective readme files:
* `endaq.calc` ([readme](https://github.com/MideTechnology/endaq-python/tree/main/endaq/calc)): A computational backend for vibration analysis.
* `endaq.cloud` ([readme](https://github.com/MideTechnology/endaq-python/tree/main/endaq/cloud)): Tools for interacting with enDAQ Cloud services.
* `endaq.ide` ([readme](https://github.com/MideTechnology/endaq-python/tree/main/endaq/ide)): High-level utility functions to aid in importing and inspecting enDAQ IDE recording files.
* `endaq.plot` ([readme](https://github.com/MideTechnology/endaq-python/tree/main/endaq/plot)): A package comprising a collection of plotting utilities for sensor data analysis.
## Docs
The docs for this package can be found [here](https://docs.endaq.com/en/latest/).
To locally build the [Sphinx](https://www.sphinx-doc.org) documentation from a clone of the repo:
1. `cd <repo root dir>`
2. `pip install -e .[docs]`
3. `sphinx-build -W -b html docs docs/_build`
## License
The endaq-python repository is licensed under the MIT license. The full text can be found in the [LICENSE file](https://github.com/MideTechnology/endaq-python/blob/main/LICENSE).
Raw data
{
"_id": null,
"home_page": "https://github.com/MideTechnology/endaq-python",
"name": "endaq",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ebml binary ide mide endaq",
"author": "Mide Technology",
"author_email": "help@mide.com",
"download_url": "https://files.pythonhosted.org/packages/06/80/4c49e0feffeeae2537a51c993a434161c746c1926823f40c7b19109776f2/endaq-1.5.2.tar.gz",
"platform": null,
"description": " [](https://codecov.io/gh/MideTechnology/endaq-python)\n\n# `endaq-python`: A comprehensive, user-centric Python API for working with enDAQ data and devices\n\n\n## Installation\n\nendaq is available on PYPI via `pip`:\n\n pip install endaq\n\nFor the most recent features that are still under development, you can also use `pip` to install endaq directly from GitHub:\n\n pip install git+https://github.com/MideTechnology/endaq-python.git@development\n\n## Contents\n\nThis package consists of several submodules, you can read more about how these are used in their respective readme files:\n* `endaq.calc` ([readme](https://github.com/MideTechnology/endaq-python/tree/main/endaq/calc)): A computational backend for vibration analysis.\n* `endaq.cloud` ([readme](https://github.com/MideTechnology/endaq-python/tree/main/endaq/cloud)): Tools for interacting with enDAQ Cloud services.\n* `endaq.ide` ([readme](https://github.com/MideTechnology/endaq-python/tree/main/endaq/ide)): High-level utility functions to aid in importing and inspecting enDAQ IDE recording files.\n* `endaq.plot` ([readme](https://github.com/MideTechnology/endaq-python/tree/main/endaq/plot)): A package comprising a collection of plotting utilities for sensor data analysis.\n\n## Docs\n\nThe docs for this package can be found [here](https://docs.endaq.com/en/latest/).\n\nTo locally build the [Sphinx](https://www.sphinx-doc.org) documentation from a clone of the repo:\n1. `cd <repo root dir>`\n2. `pip install -e .[docs]`\n3. `sphinx-build -W -b html docs docs/_build`\n\n## License \n\nThe endaq-python repository is licensed under the MIT license. The full text can be found in the [LICENSE file](https://github.com/MideTechnology/endaq-python/blob/main/LICENSE).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A comprehensive, user-centric Python API for working with enDAQ data and devices",
"version": "1.5.2",
"split_keywords": [
"ebml",
"binary",
"ide",
"mide",
"endaq"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "0e4ecb637213c0b0f49ee90699858c9f",
"sha256": "0a516e5410c8933bf4c866c76a59349604b03a878fd9aa944caad9f65b8c039e"
},
"downloads": -1,
"filename": "endaq-1.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0e4ecb637213c0b0f49ee90699858c9f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 112583,
"upload_time": "2022-12-14T17:56:00",
"upload_time_iso_8601": "2022-12-14T17:56:00.041815Z",
"url": "https://files.pythonhosted.org/packages/c2/41/49a49f253003137fe9ea51068e829b7d792984173e5390b7cda038ffe1f9/endaq-1.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "0e114030b3665d1614b4d2c97abb905e",
"sha256": "da644d75d6cce7a245d4bd5438bfc191731e9eedfd382998ef0f75c25c9b263b"
},
"downloads": -1,
"filename": "endaq-1.5.2.tar.gz",
"has_sig": false,
"md5_digest": "0e114030b3665d1614b4d2c97abb905e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 98481,
"upload_time": "2022-12-14T17:56:01",
"upload_time_iso_8601": "2022-12-14T17:56:01.459150Z",
"url": "https://files.pythonhosted.org/packages/06/80/4c49e0feffeeae2537a51c993a434161c746c1926823f40c7b19109776f2/endaq-1.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-14 17:56:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "MideTechnology",
"github_project": "endaq-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "endaq"
}
JSON
