Name | stidapi JSON |
Version |
1.3.4
JSON |
| download |
home_page | None |
Summary | Python client for connecting to Equinor STIDapi |
upload_time | 2025-03-20 12:25:47 |
maintainer | None |
docs_url | None |
author | Åsmund Våge Fannemel |
requires_python | <4.0.0,>=3.9.2 |
license | Proprietary |
keywords |
|
VCS |
 |
bugtrack_url |
|
requirements |
No requirements were recorded.
|
Travis-CI |
No Travis.
|
coveralls test coverage |
No coveralls.
|
# STIDapi-python [](https://github.com/equinor/STIDapi-python/actions/workflows/snyk.yml)
A simple wrapper package to interface Equinor [STIDapi](https://stidapi.equinor.com/) using python and get plant, system, tag and doc data.
## Use
Try it out by running the [demo](examples/demo.py) or the sample code below.
```
from stidapi import Plant, Tag, Doc
p = Plant("JSV")
t = p.search_tag("*20LIC*")
t2 = Tag("JSV",t[0].no)
d = t2.get_doc()
d2 = p.get_doc(d[0].no)
d3 = Doc(p.inst_code, d[0].no)
```
## Installing
Install package from pypi using `pip install stidapi`
## Developing / testing
Poetry is preferred for developers. Install with required packages for testing and coverage:
`poetry install`
Call `poetry run pytest` to run tests.
To generate coverage report in html run `poetry run pytest --cov=stidapi tests/ --cov-report html`
Raw data
{
"_id": null,
"home_page": null,
"name": "stidapi",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.9.2",
"maintainer_email": null,
"keywords": null,
"author": "\u00c5smund V\u00e5ge Fannemel",
"author_email": "asmf@equinor.com",
"download_url": "https://files.pythonhosted.org/packages/83/c2/6194b2439a8cf81f79753e5d46c5dce25cce6ddec66e84fe3c67da4b0fd1/stidapi-1.3.4.tar.gz",
"platform": null,
"description": "# STIDapi-python [](https://github.com/equinor/STIDapi-python/actions/workflows/snyk.yml)\n\nA simple wrapper package to interface Equinor [STIDapi](https://stidapi.equinor.com/) using python and get plant, system, tag and doc data.\n\n\n## Use\n\nTry it out by running the [demo](examples/demo.py) or the sample code below.\n\n```\nfrom stidapi import Plant, Tag, Doc\n\n\np = Plant(\"JSV\")\nt = p.search_tag(\"*20LIC*\")\nt2 = Tag(\"JSV\",t[0].no)\n\n\nd = t2.get_doc()\nd2 = p.get_doc(d[0].no)\nd3 = Doc(p.inst_code, d[0].no)\n```\n\n## Installing\n\nInstall package from pypi using `pip install stidapi`\n\n## Developing / testing\n\nPoetry is preferred for developers. Install with required packages for testing and coverage: \n`poetry install`\n\nCall `poetry run pytest` to run tests.\n\nTo generate coverage report in html run `poetry run pytest --cov=stidapi tests/ --cov-report html`\n\n",
"bugtrack_url": null,
"license": "Proprietary",
"summary": "Python client for connecting to Equinor STIDapi",
"version": "1.3.4",
"project_urls": {
"repository": "https://github.com/equinor/STIDapi-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "834c3fdb4018657470d75d8dee082e0e7137c6012af3ac9d46c0a7766beddc20",
"md5": "b3d6746b860e17ccca289a5853b481fe",
"sha256": "04812fb16f71d48afe630a786878e035b7bd63ef658c81c216feb36d07cb9daf"
},
"downloads": -1,
"filename": "stidapi-1.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3d6746b860e17ccca289a5853b481fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.9.2",
"size": 8867,
"upload_time": "2025-03-20T12:25:46",
"upload_time_iso_8601": "2025-03-20T12:25:46.308737Z",
"url": "https://files.pythonhosted.org/packages/83/4c/3fdb4018657470d75d8dee082e0e7137c6012af3ac9d46c0a7766beddc20/stidapi-1.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "83c26194b2439a8cf81f79753e5d46c5dce25cce6ddec66e84fe3c67da4b0fd1",
"md5": "b08aa72a358ffc90e807712cfe146457",
"sha256": "2a758aed1d14703860d60cf3cf8cf5e68b42a3fee6913938542bb1395e2df0bc"
},
"downloads": -1,
"filename": "stidapi-1.3.4.tar.gz",
"has_sig": false,
"md5_digest": "b08aa72a358ffc90e807712cfe146457",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.9.2",
"size": 7432,
"upload_time": "2025-03-20T12:25:47",
"upload_time_iso_8601": "2025-03-20T12:25:47.288528Z",
"url": "https://files.pythonhosted.org/packages/83/c2/6194b2439a8cf81f79753e5d46c5dce25cce6ddec66e84fe3c67da4b0fd1/stidapi-1.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-20 12:25:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "equinor",
"github_project": "STIDapi-python",
"github_not_found": true,
"lcname": "stidapi"
}