stidapi

Name	stidapi JSON
Version	1.3.1 JSON
	download
home_page	None
Summary	Python client for connecting to Equinor STIDapi
upload_time	2025-01-08 11:22:43
maintainer	None
docs_url	None
author	Åsmund Våge Fannemel
requires_python	<4.0,>=3.9
license	Proprietary
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # STIDapi-python [![SNYK dependency check](https://github.com/equinor/STIDapi-python/actions/workflows/snyk.yml/badge.svg)](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,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "\u00c5smund V\u00e5ge Fannemel",
    "author_email": "asmf@equinor.com",
    "download_url": "https://files.pythonhosted.org/packages/fa/5e/a33d0702c3b2798b8e5cfc8645f1fe5f9f6fb153819377e3e09c17bab5db/stidapi-1.3.1.tar.gz",
    "platform": null,
    "description": "# STIDapi-python [![SNYK dependency check](https://github.com/equinor/STIDapi-python/actions/workflows/snyk.yml/badge.svg)](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.1",
    "project_urls": {
        "repository": "https://github.com/equinor/STIDapi-python"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e858b49d55eaf49a9e9732b475032c0ef05c776d7db1f8e6087c277a2ca46322",
                "md5": "3a4fbcfa39329e5036ae21ebbb340c77",
                "sha256": "b2cf21876d7034b4f1dfd59b9793b5368790d183533072181e982fe3538cbfd6"
            },
            "downloads": -1,
            "filename": "stidapi-1.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3a4fbcfa39329e5036ae21ebbb340c77",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 8635,
            "upload_time": "2025-01-08T11:22:40",
            "upload_time_iso_8601": "2025-01-08T11:22:40.860234Z",
            "url": "https://files.pythonhosted.org/packages/e8/58/b49d55eaf49a9e9732b475032c0ef05c776d7db1f8e6087c277a2ca46322/stidapi-1.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fa5ea33d0702c3b2798b8e5cfc8645f1fe5f9f6fb153819377e3e09c17bab5db",
                "md5": "d10a4d12fb10b7ace6d2f91cd2d4604c",
                "sha256": "3ce98f4330f3a338ba7f3c0338da192bab6b11d36696bc3b6ec86fad4b64c818"
            },
            "downloads": -1,
            "filename": "stidapi-1.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d10a4d12fb10b7ace6d2f91cd2d4604c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 7265,
            "upload_time": "2025-01-08T11:22:43",
            "upload_time_iso_8601": "2025-01-08T11:22:43.187002Z",
            "url": "https://files.pythonhosted.org/packages/fa/5e/a33d0702c3b2798b8e5cfc8645f1fe5f9f6fb153819377e3e09c17bab5db/stidapi-1.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-08 11:22:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "equinor",
    "github_project": "STIDapi-python",
    "github_not_found": true,
    "lcname": "stidapi"
}