Metadata-Version: 2.4
Name: commonlib-reader
Version: 1.1.2
Summary: Reader for Equinor commonlib api.
License: MIT
Author: Åsmund Våge Fannemel
Author-email: asmf@equinor.com
Requires-Python: >=3.10,<4.0.0
Classifier: License :: OSI Approved :: MIT 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.0,<2.0.0)
Requires-Dist: pandas (>=2.1.4)
Requires-Dist: requests (>=2.32.4)
Requires-Dist: urllib3 (>=2.5.0)
Project-URL: Repository, https://github.com/equinor/commonlib-reader.git
Description-Content-Type: text/markdown

# commonlib-reader [![SNYK dependency check](https://github.com/equinor/commonlib-reader/actions/workflows/snyk.yml/badge.svg)](https://github.com/equinor/commonlib-reader/actions/workflows/snyk.yml)
Connector package for Equinor [Commonlib](https://commonlib.equinor.com/) [api](https://commonlibapi.equinor.com/swagger/index.html). 

Current features:
- Reading code tables
- Getting facility data using the [Facility](commonlib_reader/facility.py) class
- [IMS source ](commonlib_reader/ims.py) lookup tables for facilities
- Getting Tag category, Tag type, Tag format, and Tag format element data. See [tag.py](commonlib_reader/tag.py)
- Getting [units of measure](commonlib_reader/ims.py) definitions.


## Use
Try it out by running the [demo](examples/demo.py).

## Installing

Install package from pypi using `pip install commonlib_reader`


## Developing / testing

Poetry is preferred for developers. Clone and install with required packages for testing and coverage:  
`poetry install`

For testing with coverage run:  
`poetry run pytest --cov --cov-report=html`

