# tagreader-python <!-- omit in toc -->
[](https://pepy.tech/project/tagreader)
Tagreader is a Python package for reading timeseries data from the OSIsoft PI and Aspen Infoplus.21
Information Manufacturing Systems (IMS) systems. It is intended to be easy to use, and present as similar interfaces
as possible to the backend historians.
## Installation
You can install tagreader directly into your project from pypi by using pip
or another package manager. The only requirement is Python version 3.8 or above.
```shell"
pip install tagreader
```
The following are required and will be installed:
* pandas
* requests
* requests-kerberos
* certifi
* diskcache
## Usage
Tagreader easy to use for both Equinor internal IMS services, and non-internal usage. For non-internal usage
you simply need to provide the corresponding IMS service URLs and IMSType.
See [data source](https://equinor.github.io/tagreader-python/docs/about/usage/data-source) for details.
### Usage example
```python
import tagreader
c = tagreader.IMSClient("mysource", "aspenone")
print(c.search("tag*"))
df = c.read_tags(["tag1", "tag2"], "18.06.2020 08:00:00", "18.06.2020 09:00:00", 60)
```
Note, you can add a timeout argument to the search method in order to avoid long-running search queries.
### Jupyter Notebook Quickstart
Jupyter Notebook examples can be found in /examples. In order to run these examples, you need to install the
optional dependencies.
```shell
pip install tagreader[notebooks]
```
The quickstart Jupyter Notebook can be found [here](https://github.com/equinor/tagreader-python/blob/main/examples/quickstart.ipynb)
For more details, see the [Tagreader Docs](https://equinor.github.io/tagreader-python/).
## Documentation
The full documentation can be found in [Tagreader Docs](https://equinor.github.io/tagreader-python/)
## Contribute
To starting contributing, please see [Tagreader Docs - Contribute](https://equinor.github.io/tagreader-python/docs/contribute/overview)
Raw data
{
"_id": null,
"home_page": "https://github.com/equinor/tagreader-python",
"name": "tagreader",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "Aspen InfoPlus.21, OSIsoft PI",
"author": "Einar S. Ids\u00f8",
"author_email": "eiids@equinor.com",
"download_url": "https://files.pythonhosted.org/packages/e6/85/b1562a134fa29e1debbec5d993e5b6493fd76c6c2ea07fdd6d3098299590/tagreader-6.0.1.tar.gz",
"platform": null,
"description": "# tagreader-python <!-- omit in toc -->\n\n\n\n\n[](https://pepy.tech/project/tagreader)\n\nTagreader is a Python package for reading timeseries data from the OSIsoft PI and Aspen Infoplus.21\nInformation Manufacturing Systems (IMS) systems. It is intended to be easy to use, and present as similar interfaces\nas possible to the backend historians.\n\n## Installation\nYou can install tagreader directly into your project from pypi by using pip\nor another package manager. The only requirement is Python version 3.8 or above.\n\n```shell\"\npip install tagreader\n```\n\nThe following are required and will be installed:\n\n* pandas\n* requests\n* requests-kerberos\n* certifi\n* diskcache\n\n## Usage\nTagreader easy to use for both Equinor internal IMS services, and non-internal usage. For non-internal usage\nyou simply need to provide the corresponding IMS service URLs and IMSType.\nSee [data source](https://equinor.github.io/tagreader-python/docs/about/usage/data-source) for details.\n\n### Usage example\n```python\nimport tagreader\nc = tagreader.IMSClient(\"mysource\", \"aspenone\")\nprint(c.search(\"tag*\"))\ndf = c.read_tags([\"tag1\", \"tag2\"], \"18.06.2020 08:00:00\", \"18.06.2020 09:00:00\", 60)\n```\n\nNote, you can add a timeout argument to the search method in order to avoid long-running search queries.\n\n### Jupyter Notebook Quickstart\nJupyter Notebook examples can be found in /examples. In order to run these examples, you need to install the\noptional dependencies.\n\n```shell\npip install tagreader[notebooks]\n```\n\nThe quickstart Jupyter Notebook can be found [here](https://github.com/equinor/tagreader-python/blob/main/examples/quickstart.ipynb)\n\nFor more details, see the [Tagreader Docs](https://equinor.github.io/tagreader-python/).\n\n## Documentation\nThe full documentation can be found in [Tagreader Docs](https://equinor.github.io/tagreader-python/)\n\n## Contribute\nTo starting contributing, please see [Tagreader Docs - Contribute](https://equinor.github.io/tagreader-python/docs/contribute/overview)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Tagreader is a Python package for reading trend data from the OSIsoft PI and Aspen Infoplus.21 IMS systems.",
"version": "6.0.1",
"project_urls": {
"Homepage": "https://github.com/equinor/tagreader-python",
"Repository": "https://github.com/equinor/tagreader-python"
},
"split_keywords": [
"aspen infoplus.21",
" osisoft pi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c82e9a7cacf79987744ed4abe336ad31b1f17dd687c4fb306034d82d0faabd7f",
"md5": "1ae9db969c64766c90bd644f96d019d4",
"sha256": "10d929e91cb7163291db98e9365e8ee1e924b1eabf0851a571db714f0fb8b73e"
},
"downloads": -1,
"filename": "tagreader-6.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ae9db969c64766c90bd644f96d019d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 24718,
"upload_time": "2024-10-03T10:20:10",
"upload_time_iso_8601": "2024-10-03T10:20:10.330745Z",
"url": "https://files.pythonhosted.org/packages/c8/2e/9a7cacf79987744ed4abe336ad31b1f17dd687c4fb306034d82d0faabd7f/tagreader-6.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e685b1562a134fa29e1debbec5d993e5b6493fd76c6c2ea07fdd6d3098299590",
"md5": "034aef60c61d05af4678d0ce4ead44a4",
"sha256": "a6420fbb99b93d6a91d2f0b5da1fdca42b9e5270023b11d9ddd2e32bad410866"
},
"downloads": -1,
"filename": "tagreader-6.0.1.tar.gz",
"has_sig": false,
"md5_digest": "034aef60c61d05af4678d0ce4ead44a4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 23125,
"upload_time": "2024-10-03T10:20:12",
"upload_time_iso_8601": "2024-10-03T10:20:12.213771Z",
"url": "https://files.pythonhosted.org/packages/e6/85/b1562a134fa29e1debbec5d993e5b6493fd76c6c2ea07fdd6d3098299590/tagreader-6.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-03 10:20:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "equinor",
"github_project": "tagreader-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tagreader"
}
JSON
