# PYVIUM
Tiny Python wrapper around the "Software development driver DLL" for IviumSoft.
# Important:
This module uses a dll from the IviumSoft application. You need to have this software installed on a Windows machine. The IviumSoft application can be downloaded from here: https://www.ivium.com/support/#Software%20update
This version of Pyvium has been tested for IviumSoft release 4.1170.
## Installation
Install PYVIUM easily with pip:
```
pip install pyvium
```
Or with poetry:
```
poetry add pyvium
```
## Usage Example (Using IviumSoft Core functions)
To use the same functions available in the "IviumSoft driver DLL" you can import the Core class as follows. All functions return a result code (integer) and a result value if available. For further information you can check the IviumSoft documentation.
```
from pyvium import Core
Core.IV_open()
Core.IV_getdevicestatus()
Core.IV_close()
```
## Usage Example (Using Pyvium methods)
This is a wrapper around the Core functions that adds a few things:
- Exception management (you can find an example [here](https://github.com/SF-Tec/pyvium/blob/main/docs/error_management.md))
- New functionalities
```
from pyvium import Pyvium
Pyvium.open_driver()
Pyvium.get_device_status()
Pyvium.close_driver()
```
## Usage Example (Using Tools methods)
This offers further functionality in data processing:
```
from pyvium import Tools
Tools.convert_idf_dir_to_csv()
```
## Supported functions
The list of currently supported and implemented functions can be found [here](https://github.com/SF-Tec/pyvium/blob/main/docs/method_list.md).
## Links
- [See on GitHub](https://github.com/sf-tec/pyvium)
- [See on PyPI](https://pypi.org/project/pyvium)
Raw data
{
"_id": null,
"home_page": "https://github.com/SF-Tec/pyvium",
"name": "pyvium",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": "ivium, iviumsoft, ivium software, ivium compactstat",
"author": "Alejandro Guti\u00e9rrez",
"author_email": "agutierrez@stec.es",
"download_url": "https://files.pythonhosted.org/packages/57/6b/9296fdf81fd860f7eb22fbc85605d8d7d786b5fcfacd2646a6c2bcf90f16/pyvium-0.1.19b0.tar.gz",
"platform": null,
"description": "# PYVIUM\n\nTiny Python wrapper around the \"Software development driver DLL\" for IviumSoft.\n\n# Important:\n\nThis module uses a dll from the IviumSoft application. You need to have this software installed on a Windows machine. The IviumSoft application can be downloaded from here: https://www.ivium.com/support/#Software%20update\n\nThis version of Pyvium has been tested for IviumSoft release 4.1170.\n\n## Installation\n\nInstall PYVIUM easily with pip:\n\n```\npip install pyvium\n```\n\nOr with poetry:\n\n```\npoetry add pyvium\n```\n\n## Usage Example (Using IviumSoft Core functions)\n\nTo use the same functions available in the \"IviumSoft driver DLL\" you can import the Core class as follows. All functions return a result code (integer) and a result value if available. For further information you can check the IviumSoft documentation.\n\n```\nfrom pyvium import Core\n\nCore.IV_open()\nCore.IV_getdevicestatus()\nCore.IV_close()\n```\n\n## Usage Example (Using Pyvium methods)\n\nThis is a wrapper around the Core functions that adds a few things:\n\n- Exception management (you can find an example [here](https://github.com/SF-Tec/pyvium/blob/main/docs/error_management.md))\n- New functionalities\n\n```\nfrom pyvium import Pyvium\n\nPyvium.open_driver()\nPyvium.get_device_status()\nPyvium.close_driver()\n\n```\n## Usage Example (Using Tools methods)\n\nThis offers further functionality in data processing:\n\n\n```\nfrom pyvium import Tools\n\nTools.convert_idf_dir_to_csv()\n\n```\n\n## Supported functions\n\nThe list of currently supported and implemented functions can be found [here](https://github.com/SF-Tec/pyvium/blob/main/docs/method_list.md).\n\n## Links\n\n- [See on GitHub](https://github.com/sf-tec/pyvium)\n- [See on PyPI](https://pypi.org/project/pyvium)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A tiny Python wrapper around the <Software development driver DLL> for IviumSoft.",
"version": "0.1.19b0",
"project_urls": {
"Homepage": "https://github.com/SF-Tec/pyvium",
"Repository": "https://github.com/SF-Tec/pyvium"
},
"split_keywords": [
"ivium",
" iviumsoft",
" ivium software",
" ivium compactstat"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87eeb57d6ae729996f47253cbf22c6f42fdc653b22d496897812246ced6acd3d",
"md5": "65e1164f95d3e29fc198c30fbfe1a0c0",
"sha256": "f4e3ecd2eda6894821d0bf5e9717caa465667b88a6b39cb25a50ebfe51b73262"
},
"downloads": -1,
"filename": "pyvium-0.1.19b0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "65e1164f95d3e29fc198c30fbfe1a0c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 2284944,
"upload_time": "2024-10-09T12:25:58",
"upload_time_iso_8601": "2024-10-09T12:25:58.320613Z",
"url": "https://files.pythonhosted.org/packages/87/ee/b57d6ae729996f47253cbf22c6f42fdc653b22d496897812246ced6acd3d/pyvium-0.1.19b0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "576b9296fdf81fd860f7eb22fbc85605d8d7d786b5fcfacd2646a6c2bcf90f16",
"md5": "b971606a10544558bbe9608c3fe58bfd",
"sha256": "712276f555c1680abbd171d41c98ab2ca6be433287bf9d4151c69b108df55b8a"
},
"downloads": -1,
"filename": "pyvium-0.1.19b0.tar.gz",
"has_sig": false,
"md5_digest": "b971606a10544558bbe9608c3fe58bfd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 2261609,
"upload_time": "2024-10-09T12:26:03",
"upload_time_iso_8601": "2024-10-09T12:26:03.411110Z",
"url": "https://files.pythonhosted.org/packages/57/6b/9296fdf81fd860f7eb22fbc85605d8d7d786b5fcfacd2646a6c2bcf90f16/pyvium-0.1.19b0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 12:26:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SF-Tec",
"github_project": "pyvium",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyvium"
}
JSON
