Merge branch 'main' into mo-asset-search-error

Author: asmfstatoil

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Ref. https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+* @Asgmel03 @lawoEq

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: '🧪 Build & test code'
+name: "🧪 Build & test code"
 
 on:
   workflow_dispatch:
@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
         os: [windows-latest, ubuntu-latest, macos-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -29,7 +29,7 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{matrix.python-version}}
-          cache: 'poetry'
+          cache: "poetry"
 
       - name: Check pyproject.toml validity
         run: poetry check --no-interaction

.pre-commit-config.yaml

@@ -1,25 +1,25 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v4.5.0
     hooks:
       - id: check-yaml
       - id: check-json
       - id: trailing-whitespace
       - id: check-merge-conflict
   - repo: https://github.com/psf/black
-    rev: 23.3.0
+    rev: 24.2.0
     hooks:
       - id: black
         language_version: python3
 
   - repo: https://github.com/PyCQA/flake8
-    rev: '6.0.0'
+    rev: '7.0.0'
     hooks:
       - id: flake8
-        args: ['--ignore=E501,W503,E231,E503,E203,F401,E702']
+        args: ['--ignore=E501,W503,E231,E503,E203,F401,E702,E704']
 
   - repo: https://github.com/timothycrosley/isort
-    rev: '5.12.0'
+    rev: '5.13.2'
     hooks:
       - id: isort
         args:
@@ -31,7 +31,7 @@ repos:
           ]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.1
+    rev: v1.9.0
     hooks:
       - id: mypy
         args: [--strict, --ignore-missing-imports]

.snyk

@@ -1,28 +1,15 @@
 # Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
 # ignores vulnerabilities until expiry date; change duration by modifying expiry date
 ignore:
-  SNYK-PYTHON-CRYPTOGRAPHY-6050294:
-    - '*':
-        reason: 'No patch available, false positive'
-        expires: 2024-04-01T00:00:00.000Z
-        created: 2023-11-15T11:05:00.000Z
-
-  SNYK-PYTHON-CRYPTOGRAPHY-6126975:
-    - '*':
-        reason: 'No patch available, false positive'
-        expires: 2024-04-01T00:00:00.000Z
-        created: 2023-12-15T11:05:00.000Z
-
   SNYK-JS-INFLIGHT-6095116:
     - '*':
-        reason: 'No patch available, false positive'
-        expires: 2024-04-01T00:00:00.000Z
+        reason: 'No patch available'
+        expires: 2025-04-01T00:00:00.000Z
         created: 2023-12-04T09:05:00.000Z
-
-  SNYK-JS-FOLLOWREDIRECTS-6141137:
+  SNYK-PYTHON-PANDAS-8549481:
     - '*':
-        reason: 'No patch available, false positive'
-        expires: 2024-04-01T00:00:00.000Z
-        created: 2024-01-02T11:05:00.000Z
+        reason: 'No patch available'
+        expires: 2025-04-01T00:00:00.000Z
+        created: 2025-01-02T10:30:00.000Z
 patch: {}
 version: v1.25.0

CHANGELOG.md

@@ -2,6 +2,117 @@
 
 This changelog is deprecated. All changes are documented under [releases](https://github.com/equinor/tagreader-python/releases).
 
+## [6.0.1](https://github.com/equinor/tagreader-python/compare/v6.0.0...v6.0.1) (2024-10-03)
+
+
+### 🐛 Bug Fixes
+
+* include all hashlib.new inputs ([#379](https://github.com/equinor/tagreader-python/issues/379)) ([de319cf](https://github.com/equinor/tagreader-python/commit/de319cf99095897bdd5155e6da542a95f9dae392))
+
+## [6.0.0](https://github.com/equinor/tagreader-python/compare/v5.5.0...v6.0.0) (2024-09-13)
+
+
+### ⚠ BREAKING CHANGES
+
+* update code to work with updated pi backend ([#372](https://github.com/equinor/tagreader-python/issues/372))
+
+### 🧹 Chores
+
+* bump allowed msal-bearer ([#375](https://github.com/equinor/tagreader-python/issues/375)) ([bd1e332](https://github.com/equinor/tagreader-python/commit/bd1e332636e6c07bc1ade0f4482711e14e9b54f9))
+
+
+### ✨ Features
+
+* update code to work with updated pi backend ([#372](https://github.com/equinor/tagreader-python/issues/372)) ([9da2963](https://github.com/equinor/tagreader-python/commit/9da296357364545f4e66a119551cc0af67587c88))
+
+
+### 🐛 Bug Fixes
+
+* fix bug with wrong url for pi ([b283859](https://github.com/equinor/tagreader-python/commit/b2838599471340fd657cf38568d21feb67ed2673))
+
+## [5.5.0](https://github.com/equinor/tagreader-python/compare/v5.4.0...v5.5.0) (2024-08-19)
+
+
+### 📦 Build system
+
+* **deps:** Update dependencies and snyk ignore ([0db35a4](https://github.com/equinor/tagreader-python/commit/0db35a4b017d666a3d6ec8b8a717af3c0f1fcafa))
+
+
+### ✨ Features
+
+* return more aspen tag search results ([#357](https://github.com/equinor/tagreader-python/issues/357)) ([89f7961](https://github.com/equinor/tagreader-python/commit/89f7961f148861e543696e8edc3b161fd4335566))
+* return more search tag search results ([89f7961](https://github.com/equinor/tagreader-python/commit/89f7961f148861e543696e8edc3b161fd4335566))
+
+## [5.4.0](https://github.com/equinor/tagreader-python/compare/v5.3.0...v5.4.0) (2024-06-03)
+
+
+### 🧹 Chores
+
+* **deps:** bump jinja2 from 3.1.3 to 3.1.4 ([#343](https://github.com/equinor/tagreader-python/issues/343)) ([3503905](https://github.com/equinor/tagreader-python/commit/350390522f51aeb470f9a36d47f732cb0470cb73))
+* **deps:** bump msal-bearer from 0.2.1 to 1.0.0 ([#348](https://github.com/equinor/tagreader-python/issues/348)) ([f93e38f](https://github.com/equinor/tagreader-python/commit/f93e38f56242bf83407f31aa9c2c2bc9b14a2edc))
+* **deps:** bump pytest from 7.4.4 to 8.2.1 ([#345](https://github.com/equinor/tagreader-python/issues/345)) ([716b084](https://github.com/equinor/tagreader-python/commit/716b0845329af0a951d87081dd23162f642e5f3b))
+* **deps:** bump requests from 2.31.0 to 2.32.3 ([#350](https://github.com/equinor/tagreader-python/issues/350)) ([0e79987](https://github.com/equinor/tagreader-python/commit/0e799876c099181b1e94e0c0d2300dea6c38effc))
+* update manual.md ([5f3bc1a](https://github.com/equinor/tagreader-python/commit/5f3bc1afd5398c1677fa7f4fa71bc482b8239c4e))
+
+
+### ✨ Features
+
+* cleanup remove unused statoil certificate ([#337](https://github.com/equinor/tagreader-python/issues/337)) ([5f3bc1a](https://github.com/equinor/tagreader-python/commit/5f3bc1afd5398c1677fa7f4fa71bc482b8239c4e))
+
+
+### 🐛 Bug Fixes
+
+* handle invalid description search from aspen ([#340](https://github.com/equinor/tagreader-python/issues/340)) ([39a9364](https://github.com/equinor/tagreader-python/commit/39a93640160735d44e2c4f4dcb5678b2a6e467cc))
+
+## [5.3.0](https://github.com/equinor/tagreader-python/compare/v5.2.1...v5.3.0) (2024-04-19)
+
+
+### 📦 Build system
+
+* update snyk ignores and docusaurus ([#334](https://github.com/equinor/tagreader-python/issues/334)) ([a7aa362](https://github.com/equinor/tagreader-python/commit/a7aa362e4f732299e457b6538190f69c60cfb77b))
+
+
+### ✨ Features
+
+* aspen query_sql get host from source name ([#323](https://github.com/equinor/tagreader-python/issues/323)) ([bb6eced](https://github.com/equinor/tagreader-python/commit/bb6ecedad9c42ff346b492fd3111bcf6cea9b66f))
+
+
+### 🐛 Bug Fixes
+
+* got external url by default ([#339](https://github.com/equinor/tagreader-python/issues/339)) ([6df4a56](https://github.com/equinor/tagreader-python/commit/6df4a562194d2290f724561dce5a52e517cae07a))
+* remove circular import ([bb6eced](https://github.com/equinor/tagreader-python/commit/bb6ecedad9c42ff346b492fd3111bcf6cea9b66f))
+
+## [5.2.1](https://github.com/equinor/tagreader-python/compare/v5.2.0...v5.2.1) (2024-03-18)
+
+
+### 📦 Build system
+
+* **deps:** relax requests-ntlm version requirement ([61f3cd2](https://github.com/equinor/tagreader-python/commit/61f3cd2c883c57fcec627ca989f95df167a64600))
+
+## [5.2.0](https://github.com/equinor/tagreader-python/compare/v5.1.3...v5.2.0) (2024-03-18)
+
+
+### 🧹 Chores
+
+* update snyk ignore ([9428ffd](https://github.com/equinor/tagreader-python/commit/9428ffd3ea44913746465144a5eea8e2490ec228))
+
+
+### 👷 CI/CD
+
+* update tagreader dependencies ([ec16d46](https://github.com/equinor/tagreader-python/commit/ec16d4610cfd2ab1f39c66ea14b96175b32360c5))
+
+
+### ✨ Features
+
+* add legacy support for MD4 in Python patch versions greater than 4. Used in NTLM auth ([f9ac0c1](https://github.com/equinor/tagreader-python/commit/f9ac0c107ab51493fb1997ba6cc8aa448e795c9e))
+* authenticate to aspen api using bearer token ([#154](https://github.com/equinor/tagreader-python/issues/154)) ([5e40b27](https://github.com/equinor/tagreader-python/commit/5e40b27806a84ecf8166430e0bcdc8d47f5f230c))
+* optionally exclude descriptions from tag search results ([#118](https://github.com/equinor/tagreader-python/issues/118)) ([857a594](https://github.com/equinor/tagreader-python/commit/857a594b16064bb4824c33e8941b546ab0c38e9e))
+
+
+### 🐛 Bug Fixes
+
+* correct signature for MD4 monkeypatch ([6bd7e5c](https://github.com/equinor/tagreader-python/commit/6bd7e5cefd31326475349a30052ceba5db01acb8))
+
 ## [5.1.3](https://github.com/equinor/tagreader-python/compare/v5.1.2...v5.1.3) (2023-12-06)
 
 

README.md

@@ -13,7 +13,7 @@ as possible to the backend historians.
 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"
+```shell
 pip install tagreader
 ```
 
@@ -26,7 +26,7 @@ The following are required and will be installed:
 * diskcache
 
 ## Usage
-Tagreader easy to use for both Equinor internal IMS services, and non-internal usage. For non-internal usage
+Tagreader is 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.
 

docs/manual.md

@@ -56,11 +56,11 @@ pip install --upgrade tagreader
 
 ***Note**: Since v2.7.0 the procedure described below will be automatically performed on Equinor hosts when importing the tagreader module. It should therefore no longer be necessary to perform this step manually.*
 
-The Web APIs are queried with the requests package. Requests does not utilize the system certificate store, but instead relies on the certifi bundle. In order to avoid SSL verification errors, we need to either turn off SSL verification (optional input argument `verifySSL=False` for relevant function calls) or, strongly preferred, add the certificate to the certifi bundle. To do this, simply activate the virtual environment where you installed tagreader, and run the following snippet:
+The Web APIs are queried with the `requests` package. `requests` does not utilize the system certificate store, but instead relies on the `certifi` bundle. In order to avoid SSL verification errors, we need to either turn off SSL verification (optional input argument `verifySSL=False` for relevant function calls) or, preferably, add the certificate to the `certifi` bundle. To do this, simply activate the virtual environment where you installed `tagreader`, and run the following snippet:
 
 ``` python
-from tagreader.utils import add_statoil_root_certificate
-add_statoil_root_certificate()
+from tagreader.utils import add_equinor_root_certificate
+    add_equinor_root_certificate()
 ```
 
 The output should inform you that the certificate was successfully added. This needs to be repeated whenever certifi is upgraded in your python virtual environment. It is safe to run more than once: If the function detects that the certificate has already been added to your current certifi installation, the certificate will not be duplicated.
@@ -117,7 +117,7 @@ The client presents the interface for communicating with the data source to the
 A connection to a data source is prepared by creating an instance of `tagreader.IMSClient` with the following input arguments:
 
 * `datasource` : Name of data source
-* `imstype` (optional): The name of the [IMS type](#ims-types) to query. Indicates the type of data source that is requested, and therefore determines which handler type to use. Valid values are `piwebapi` and `aspenone`. If not provided it will search the availble sources and find the type.
+* `imstype` (optional): The name of the [IMS type](#ims-types) to query. Indicates the type of data source that is requested, and therefore determines which handler type to use. Valid values are `piwebapi` and `aspenone`. If not provided it will search the available sources and find the type.
 * `tz` (optional): Time zone naive time stamps will be interpreted as belonging to this time zone. Similarly, the returned data points will be localized to this time zone. **Default**: _"Europe/Oslo"_.
 
 The following input arguments can be used when connecting to either `piwebapi` or to `aspenone`. None of these should be necessary to supply when connecting to Equinor servers.
@@ -209,7 +209,7 @@ Data is read by calling the client method `read()` with the following input argu
 By specifying the optional parameter `read_type` to `read()` , it is possible to specify what kind of data should be returned. The default query method is interpolated. All valid values for `read_type` are defined in the `utils.ReaderType` class (mirrored for convenience as `tagreader.ReaderType` ), although not all are currently implemented. Below is the list of implemented read types.
 
 * `INT` : The raw data points are interpolated so that one new data point is generated at each step of length `ts` starting at `start_time` and ending at or less than `ts` seconds before `end_time` .
-* The following aggregated read types perform a weighted calculation of the raw data within each interval. Where relevant, time-weighted calculations are used. Returned time stamps are anchored at the beginning of each interval. So for the 60 seconds long interval between 08:11:00 and 08:12:00, the time stamp will be 08:11:00.
+* The following aggregated read types perform a weighted calculation of the raw data within each interval, using time-weighted calculations where applicable. Returned timestamps are anchored at the beginning of each interval. For example, for a 60-second interval from 08:11:00 to 08:12:00, the timestamp will be 08:11:00.
   + `MIN` : The minimum value.
   + `MAX` : The maximum value.
   + `AVG` : The average value.

documentation/package.json

@@ -16,20 +16,30 @@
   },
   "dependencies": {
     "@akebifiky/remark-simple-plantuml": "^1.0.2",
-    "@docusaurus/core": "^3.0.1",
-    "@docusaurus/preset-classic": "^3.0.1",
-    "@docusaurus/theme-mermaid": "^3.0.1",
-    "@mdx-js/react": "^3.0.0",
-    "prism-react-renderer": "^2.3.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "rehype-katex": "7.0.0",
+    "@docusaurus/core": "^3.6.3",
+    "@docusaurus/preset-classic": "^3.6.3",
+    "@docusaurus/theme-mermaid": "^3.6.3",
+    "@mdx-js/react": "^3.1.0",
+    "prism-react-renderer": "^2.4.1",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "rehype-katex": "7.0.1",
     "remark-math": "6.0.0"
   },
   "devDependencies": {
-    "@tsconfig/docusaurus": "^2.0.2",
-    "typescript": "^5.3.2"
+    "@tsconfig/docusaurus": "^2.0.3",
+    "typescript": "^5.6.2"
   },
+  "resolutions": {
+    "cookie": "0.7.0",
+    "path-to-regexp": "0.1.12",
+    "cross-spawn": "7.0.5",
+    "nanoid": "3.3.8",
+    "body-parser": "1.20.3",
+    "express": "4.20.0",
+    "micromatch": "4.0.8"
+  },
+
   "browserslist": {
     "production": [
       ">0.5%",
@@ -44,5 +54,6 @@
   },
   "engines": {
     "node": ">=20.0"
-  }
+  },
+  "packageManager": "yarn@1.22.19+sha1.4ba7fc5c6e704fce2066ecbfb0b0d8976fe62447"
 }