Skip to content

Latest commit

 

History

History
542 lines (291 loc) · 27.4 KB

CHANGELOG.md

File metadata and controls

542 lines (291 loc) · 27.4 KB

Changelog

This changelog is deprecated. All changes are documented under releases.

6.0.1 (2024-10-03)

🐛 Bug Fixes

6.0.0 (2024-09-13)

⚠ BREAKING CHANGES

  • update code to work with updated pi backend (#372)

🧹 Chores

✨ Features

  • update code to work with updated pi backend (#372) (9da2963)

🐛 Bug Fixes

  • fix bug with wrong url for pi (b283859)

5.5.0 (2024-08-19)

📦 Build system

  • deps: Update dependencies and snyk ignore (0db35a4)

✨ Features

  • return more aspen tag search results (#357) (89f7961)
  • return more search tag search results (89f7961)

5.4.0 (2024-06-03)

🧹 Chores

  • deps: bump jinja2 from 3.1.3 to 3.1.4 (#343) (3503905)
  • deps: bump msal-bearer from 0.2.1 to 1.0.0 (#348) (f93e38f)
  • deps: bump pytest from 7.4.4 to 8.2.1 (#345) (716b084)
  • deps: bump requests from 2.31.0 to 2.32.3 (#350) (0e79987)
  • update manual.md (5f3bc1a)

✨ Features

  • cleanup remove unused statoil certificate (#337) (5f3bc1a)

🐛 Bug Fixes

  • handle invalid description search from aspen (#340) (39a9364)

5.3.0 (2024-04-19)

📦 Build system

✨ Features

  • aspen query_sql get host from source name (#323) (bb6eced)

🐛 Bug Fixes

5.2.1 (2024-03-18)

📦 Build system

  • deps: relax requests-ntlm version requirement (61f3cd2)

5.2.0 (2024-03-18)

🧹 Chores

👷 CI/CD

  • update tagreader dependencies (ec16d46)

✨ Features

  • add legacy support for MD4 in Python patch versions greater than 4. Used in NTLM auth (f9ac0c1)
  • authenticate to aspen api using bearer token (#154) (5e40b27)
  • optionally exclude descriptions from tag search results (#118) (857a594)

🐛 Bug Fixes

  • correct signature for MD4 monkeypatch (6bd7e5c)

5.1.3 (2023-12-06)

🐛 Bug Fixes

  • add both certificates until AspenOne supports the new Equinor Root CA (e6a2c2b)

5.1.2 (2023-12-05)

🧹 Chores

  • ensure that the repo is in accordance with Equinor guidelines for open-source projects (9469c22)
  • chore: avoid trying to add Statoil certificate if Equinor Root CA is already found
  • chore: avoid default caching web ids in PiHandlerWeb
  • chore: allow numpy integers and floats as timedelta arguments and add timeout to search method

🐛 Bug Fixes

  • fix: allow None-timedelta when reading Snapshots or Raw data

5.1.1 (2023-12-05)

📦 Build system

  • ignore cryptography vulnearbility. No patch available (eecaf1a)
  • remove pyodbc (719f09a)
  • remove unused dependencies (0288207)
  • upgrade Docusaurus (261c573)

5.1.0 (2023-09-28)

📦 Build system

  • deps: upgrade build dependencies (9e38faa)

🧹 Chores

✨ Features

🐛 Bug Fixes

  • correctly add root certificate for macos (ac6a884)

5.0.0 (2023-09-14)

⚠ BREAKING CHANGES

  • Client cache is no longer forced on when cache is set to None
  • ODBC based clients are no longer supported due to available REST services

🧹 Chores

  • Add information about deprecated ODBC clients and improve UX (5176de2)

📚 Documentation

  • Update Docs and examples to reflect changes in v5 (1667b9d)

✨ Features

4.3.1 (2023-09-13)

🧹 Chores

  • add deprecation warning for ODBC based clients. Will be removed in next release (0a6fd88)

4.3.0 (2023-09-12)

📦 Build system

  • deps: bump poetry.lock (2fc96ff)
  • deps: swap notebooks package and update deps (#257) (5207763)

🧹 Chores

📚 Documentation

✨ Features

🐛 Bug Fixes

  • AttributeError: 'str' object has no attribute 'localize' with c.read() (#250) (3cd2678)
  • web_handlers add default optional parameters (#248) (f40007a)

4.2.5 (2023-07-12)

👷 CI/CD

🧹 Chores

  • General code cleanup and maintenance (dff0d71)

📚 Documentation

  • Update docs and example notebook (550ac14)

🐛 Bug Fixes

  • remove default arguments from caching classes (a48db69)

4.2.3 (2023-07-12)

🧪 Tests

  • assert that cache is not SmartCache when creating a client without specifying cache (fa8d7d0)

🐛 Bug Fixes

4.2.2 (2023-07-12)

🧹 Chores

  • make tagreader.version available for user (#236) (8531d41)

4.2.1 (2023-07-06)

🧹 Chores

🐛 Bug Fixes

  • use correct arguments when reading single tag and code cleanup (#234) (e0fafd4), closes #231

4.2.0 (2023-06-28)

✨ Features

  • let user specify cache when creating the client (#227) (1ad859d)

⏪️ Revert

  • revert threading due to non-tread-safe handling of cache (#229) (6b379ef)

4.1.4 (2023-06-28)

🔨 Refactor

🧹 Chores

  • clean up logging and code format (ba82b18)
  • improve logging for web service API error (2b38479)

📦 Build system

  • deps: update poetry lock (4addde1)

4.1.3 (2023-06-21)

👷 CI/CD

  • Add workflow dispatch for publish (a68d616)
  • Make release-please publish automatically on approved release (cc30519)

🧹 Chores

✨ Features

  • Increase reading performance by reading concurrently using threads (#221) (f731c3a), closes #194

4.1.1 (2023-06-14)

📚 Documentation

  • add homepage and repo to pyproject.toml (5e90bee)

4.1.0 (2023-06-14)

🔨 Refactor

  • make code pass mypy and add strict type validation (#190) (9efc942)

✨ Features

  • add persistent web-id cache for PIWebAPI (64eb76c)
  • use diskcache as caching backend (f7f7a5f), closes #205

🐛 Bug Fixes

  • do not throw error when start and end time is submitted when using SNAPSHOT and ODBC connectors (#213) (4e9a4c9)

👷 CI/CD

  • correct PyPi test upload (8217af6)

4.0.3 (2023-06-09)

🔨 Refactor

🧹 Chores

  • Enforce typing and validate using mypy to make the code more robust (#199) (6212bb2)

📦 Build system

  • Don't install pytables for ARM64 (fe9d553)

4.0.2 (2023-06-05)

👷 CI/CD

  • correct name for PyPi upload (85fd96a)
  • correct PyPi upload secret (a59ecff)

4.0.1 (2023-06-05)

📦 Build system

  • deps: update dependencies (d9954f9)

4.0.0 (2023-05-24)

⚠ BREAKING CHANGES

  • Python 3.7 is no longer supported due to end-of-life

🧪 Tests

  • fix tests, don't raise error if package tables is not installed (#145) (df84ec9)

✨ Features

🔨 Refactor

  • get url to aspen/pi endpoints from function (#144) (4e22b5c)

🐛 Bug Fixes

  • catch exception when request does not return json (#133) (c81d811)
  • don't call unavailable functions on mac (#129) (c6f363c)
  • timestamp parsing for Pandas 2.0 (#177) (bdf0217)

👷 CI/CD

🧹 Chores

  • align docs with requirements (2c4f5d6)
  • bump notebook from 6.4.10 to 6.4.12 (#117) (02c088a)
  • deps: bump actions/checkout from 2 to 3 (#166) (53bd904)
  • deps: bump actions/setup-python from 1 to 4 (#165) (07a9caa)
  • scheduled weekly dependency update for week 08 (#163) (02645ee)

1.1.0 - 2020-06-18

Improved handling of tags with maps for Aspen IP.21.

Fixed

  • Allow tag search with tagname and description.
  • Fix fetching of correct unit for tags with map.
  • Fix fetching of correct description for tags with map.

1.0.1 - 2020-04-16

Fixed

  • Fix FutureWarning regarding use of keep_tz=False in DateTimeIndex.to_series()

1.0.0 - 2020-04-16

First release on PyPI as tagreader.

Changed

  • Rename from pyIMS to tagreader to avoid name collision on PyPI.
  • Move lots of tests to a separate private repository. Those tests need to be run on-site with functioning server connection to PI/IP.21 servers, and are currently handled in Azure Pipelines.

0.2.0 - 2019-10-08

Last release under the name pyIMS.

Changed

  • Major rewrite to accommodate for other types of connections than ODBC in the future.
  • Breaking: It is now necessary to specify imstype (pi or aspen) when initiating a client.
  • Update to new default DAS server address.

Fixed

  • Force keep_tz=False to suppress FutureWarning in Pandas >= 0.24.
  • Fix reading of digital states from PI.

Added

  • Add get_units() and get_descriptions() methods to fetch engineering units and description for specified tags.
  • Enable tag search by description.
  • Package version made available in pyims.__version__.

0.0.8 - 2019-01-17

Changed

  • Improve documentation.
  • Add commonly requested documentation, including docstring, for specifying query method for read_tags.

0.0.7 - 2018-06-18

Fixed

  • Fix bug where timezone was locked to Europe/Oslo.
  • Discovered that Pandas >=0.23 is required. 0.22 causes a weird timezone bug during DST folds when using cache.

0.0.6 - 2018-06-08

Added

  • Aspen now supports avg, min, max, rng, std and var queries. These have timestamps in the middle of the period.

Changed

  • Start preparation for supporting more read types for both Aspen and PI.
  • Define max_rows = 100000 for PI to (hopefully) avoid timeouts.

Fixed

  • Fix indexing issue (duplicate indices appeared in some cases, but are now handled).

0.0.5 - 2018-06-07

Added

  • Introduce time zones. Start- and stop time for queries are always performed relative to server time, so we have to know where the server is located. The default time zone is "Europe/Oslo", but this can be changed for e.g. Peregrino by specifying tz="America/Sao_Paulo" upon initialization of the client.

Changed

  • Cache files produced with versions < 0.0.5 must be deleted since they are not compatible the time zones.
  • Interpolated queries for IP.21 now return extrapolated values after last valid datapoint.

Fixed

  • Properly handle transitions to and from DST (Daylight savings time).
  • Queries should now always return data for exactly start_time <= time <= stop_time. Off-by-one data (e.g. no data for stop_time or data for stop_time+ts) is a bug (except for PI queries with stop_time close to DST changes, in which case PI may act silly).

0.0.4 - 2018-06-01

Fixed

  • Fix cache sorting issue when reading across two segments that were previously written in nonchronological order.

0.0.3 - 2018-05-30

Added

  • Add support for tags with mappings (relevant for SNA and SNB) by specifying tags on the form tag;map
  • Fix NaturalNameWarning when using '.' in tagnames

0.0.2 - 2018-04-13

Initial release. Supports the most common tag read queries for IP.21 and PI.