[](https://pypi.org/project/endaq/) 
# `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": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "ebml binary ide mide endaq",
"author": "Mide Technology",
"author_email": "help@mide.com",
"download_url": "https://files.pythonhosted.org/packages/3b/66/fec5ffb3fad9afba37aed6e7e6b6a5a9ef83d13511b13a14b6c2625bf559/endaq-1.5.3.tar.gz",
"platform": null,
"description": "[](https://pypi.org/project/endaq/) \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.3",
"project_urls": {
"Bug Tracker": "https://github.com/MideTechnology/endaq-python/issues",
"Documentation": "https://docs.endaq.com/en/latest/",
"Homepage": "https://github.com/MideTechnology/endaq-python",
"Source Code": "https://github.com/MideTechnology/endaq-python/tree/main"
},
"split_keywords": [
"ebml",
"binary",
"ide",
"mide",
"endaq"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4a85713bfb422a526ee2a30e34fe66d91dcc77ece01f1fa2fb0e6a2d68443fb5",
"md5": "0a0199f31436e971fc91984db72f672f",
"sha256": "8bf09454c80831e6127cea6d1437969203629dd08207f0dc235e6a49126dec32"
},
"downloads": -1,
"filename": "endaq-1.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a0199f31436e971fc91984db72f672f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 112615,
"upload_time": "2024-07-01T18:53:43",
"upload_time_iso_8601": "2024-07-01T18:53:43.137531Z",
"url": "https://files.pythonhosted.org/packages/4a/85/713bfb422a526ee2a30e34fe66d91dcc77ece01f1fa2fb0e6a2d68443fb5/endaq-1.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3b66fec5ffb3fad9afba37aed6e7e6b6a5a9ef83d13511b13a14b6c2625bf559",
"md5": "cb12a486168d8391e96ef205ae4e33ef",
"sha256": "f106049d38dc35ebaafd279d0921f25af7bcf274147059fec2aacb365ae8e679"
},
"downloads": -1,
"filename": "endaq-1.5.3.tar.gz",
"has_sig": false,
"md5_digest": "cb12a486168d8391e96ef205ae4e33ef",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 99242,
"upload_time": "2024-07-01T18:53:45",
"upload_time_iso_8601": "2024-07-01T18:53:45.266995Z",
"url": "https://files.pythonhosted.org/packages/3b/66/fec5ffb3fad9afba37aed6e7e6b6a5a9ef83d13511b13a14b6c2625bf559/endaq-1.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-01 18:53:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MideTechnology",
"github_project": "endaq-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "endaq"
}
JSON
