Metadata-Version: 2.4
Name: stidapi
Version: 1.4.1
Summary: Python client for connecting to Equinor STIDapi
License: Proprietary
Author: Åsmund Våge Fannemel
Author-email: asmf@equinor.com
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: eq-api-connector (>=1.0.1,<2.0.0)
Project-URL: repository, https://github.com/equinor/STIDapi-python
Description-Content-Type: text/markdown

# 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 run `poetry run pytest --cov=stidapi tests/ --cov-report=xml`

To compare coverage with master branch run
`poetry run diff-cover coverage.xml --compare-branch master`


