Merge branch 'develop' into u/jvanderaa_310_ubuntu_version

Author: jvanderaa

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v3"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Linting: black"
         run: "poetry run invoke black"
   bandit:
@@ -31,7 +31,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v3"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Linting: bandit"
         run: "poetry run invoke bandit"
     needs:
@@ -44,7 +44,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v3"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Linting: pydocstyle"
         run: "poetry run invoke pydocstyle"
     needs:
@@ -57,7 +57,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v3"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Linting: flake8"
         run: "poetry run invoke flake8"
     needs:
@@ -70,7 +70,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v3"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
           poetry-install-options: "--with dev"
       - name: "Linting: flake8"
@@ -85,7 +85,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v3"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
       - name: "Linting: yamllint"
         run: "poetry run invoke yamllint"
     needs:
@@ -98,7 +98,7 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v3"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
           poetry-install-options: "--with dev"
       - name: "Linting: Pylint"
@@ -113,7 +113,11 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        pydantic: ["2.x"]
+        include:
+          - python-version: "3.11"
+            pydantic: "1.x"
     runs-on: "ubuntu-24.04"
     env:
       INVOKE_LOCAL: "True"
@@ -122,12 +126,15 @@ jobs:
       - name: "Check out repository code"
         uses: "actions/checkout@v3"
       - name: "Setup environment"
-        uses: "networktocode/gh-action-setup-poetry-environment@v4"
+        uses: "networktocode/gh-action-setup-poetry-environment@v6"
         with:
           python-version: "${{ matrix.python-version }}"
           poetry-install-options: "--with dev"
       - name: "Run poetry Install"
         run: "poetry install"
+      - name: "Run poetry Install"
+        run: "pip install pydantic==1.10.13"
+        if: matrix.pydantic == '1.x'
       - name: "Run Tests"
         run: "poetry run invoke pytest --local"
     needs:

CHANGELOG.md

@@ -1,5 +1,94 @@
 # Changelog
 
+# Changelog
+
+## v2.7.0 - 2025-01-10
+
+### Added
+
+- [#303](https://github.com/networktocode/circuit-maintenance-parser/pull/303) - Add new parser for Apple
+- [#302](https://github.com/networktocode/circuit-maintenance-parser/pull/302) - Add support for Python 3.12
+- [#301](https://github.com/networktocode/circuit-maintenance-parser/pull/301) - Add new parser for PCCW
+- [#297](https://github.com/networktocode/circuit-maintenance-parser/pull/297) - Add new parser for Tata Communications
+
+### Changed
+
+- [#302](https://github.com/networktocode/circuit-maintenance-parser/pull/302) - Drop support for Python 3.8
+- [#291](https://github.com/networktocode/circuit-maintenance-parser/pull/291) - Update Windstream Parser for new emails
+
+### Dependencies
+
+- [#295](https://github.com/networktocode/circuit-maintenance-parser/pull/295) - Remove pydantic dotenv extra
+
+## v2.6.1 - 2024-06-04
+
+### Fixed
+
+- [#288](https://github.com/networktocode/circuit-maintenance-parser/pull/288) - Fixed exceptions under Pydantic 1.x.
+
+### Dependencies
+
+- [#286](https://github.com/networktocode/circuit-maintenance-parser/pull/286) - Added support for `lxml` 5.x.
+
+## v2.6.0 - 2024-04-04
+
+### Added
+
+- [#273](https://github.com/networktocode/circuit-maintenance-parser/pull/273) - Add iCal parsing to GTT/EXA
+- [#280](https://github.com/networktocode/circuit-maintenance-parser/pull/280) - Add new Windstream Parser
+
+### Changed
+
+- [#277](https://github.com/networktocode/circuit-maintenance-parser/pull/277) - Refactor the output validator `validate_empty_circuit`
+- [#281](https://github.com/networktocode/circuit-maintenance-parser/pull/281) Add the ability to support pydantic 1 and 2
+
+### Fixed
+
+- [#272](https://github.com/networktocode/circuit-maintenance-parser/pull/272) - Fix the logic in the output validator `validate_empty_circuit`
+- [#278](https://github.com/networktocode/circuit-maintenance-parser/pull/278) - Increase robustness of Crown Castle parsing
+
+## v2.5.0 - 2024-03-13
+
+### Added
+
+- [#274](https://github.com/networktocode/circuit-maintenance-parser/pull/274) - Add Global Cloud XChange Parser
+
+## v2.4.0 - 2024-02-20
+
+### Added
+
+- [#260](https://github.com/networktocode/circuit-maintenance-parser/pull/260) - Add Google parser
+- [#259](https://github.com/networktocode/circuit-maintenance-parser/pull/259) - Add Crown Castle fiber parser
+- [#258](https://github.com/networktocode/circuit-maintenance-parser/pull/258) - Add Netflix parser
+
+### Changed
+
+- [#264](https://github.com/networktocode/circuit-maintenance-parser/pull/264) - Adopt Pydantic 2.0
+- [#256](https://github.com/networktocode/circuit-maintenance-parser/pull/256) - Improved Equinix parser
+
+### Fixed
+
+- [#257](https://github.com/networktocode/circuit-maintenance-parser/pull/257) - Update incorrect file comment
+- [#255](https://github.com/networktocode/circuit-maintenance-parser/pull/255) -
+  Properly process Amazon emergency maintenance notifications
+
+## v2.3.0 - 2023-12-15
+
+### Added
+
+- [#245](https://github.com/networktocode/circuit-maintenance-parser/pull/245) [#250](https://github.com/networktocode/circuit-maintenance-parser/pull/250) [#252](https://github.com/networktocode/circuit-maintenance-parser/pull/252) - OpenAI parser by @chadell
+
+- [#249](https://github.com/networktocode/circuit-maintenance-parser/pull/249) - Add Metadata to every Maintenance, addresses issue #246 by @chadell
+
+### Changed
+
+- [#237](https://github.com/networktocode/circuit-maintenance-parser/pull/237) - Remove Python 3.7 support by @slyngshede
+
+### Fixed
+
+- [#243](https://github.com/networktocode/circuit-maintenance-parser/pull/243) - Handle broken EUNetworks cancellation messages by @jmaslak
+- [#251](https://github.com/networktocode/circuit-maintenance-parser/pull/251) Add missing Arelion entry to SUPPORTED_PROVIDERS by @glennmatthews
+
 ## v2.2.4 - 2023-07-12
 
 - #230 - Swap out tzwhere for TimezoneFinder

README.md

@@ -24,7 +24,7 @@ You can leverage this library in your automation framework to process circuit ma
 - **provider**: identifies the provider of the service that is the subject of the maintenance notification.
 - **account**: identifies an account associated with the service that is the subject of the maintenance notification.
 - **maintenance_id**: contains text that uniquely identifies (at least within the context of a specific provider) the maintenance that is the subject of the notification.
-- **circuits**: list of circuits affected by the maintenance notification and their specific impact. Note that in a maintenance canceled notification, some providers omit the circuit list, so this may be blank for maintenance notifications with a status of CANCELLED.
+- **circuits**: list of circuits affected by the maintenance notification and their specific impact. Note that in a maintenance canceled or completed notification, some providers omit the circuit list, so this may be blank for maintenance notifications with a status of CANCELLED or COMPLETED.
 - **start**: timestamp that defines the starting date/time of the maintenance in GMT.
 - **end**: timestamp that defines the ending date/time of the maintenance in GMT.
 - **stamp**: timestamp that defines the update date/time of the maintenance in GMT.
@@ -60,35 +60,47 @@ By default, there is a `GenericProvider` that supports a `SimpleProcessor` using
 
 - Arelion (previously Telia)
 - EuNetworks
+- EXA (formerly GTT) (\*)
 - NTT
 - PacketFabric
-- Telstra
+- PCCW
+- Telstra (\*)
 
 #### Supported providers based on other parsers
 
+- Apple
 - AWS
 - AquaComms
 - BSO
 - Cogent
 - Colt
+- Crown Castle Fiber
 - Equinix
-- EXA (formerly GTT)
+- EXA (formerly GTT) (\*)
 - HGC
+- Global Cloud Xchange
+- Google
 - Lumen
 - Megaport
 - Momentum
+- Netflix (AS2906 only)
+- PCCW
 - Seaborn
 - Sparkle
-- Telstra
+- Tata
+- Telstra (\*)
 - Turkcell
 - Verizon
+- Windstream
 - Zayo
 
+(\*) Providers in both lists, with BCOP standard and nonstandard parsers.
+
 > Note: Because these providers do not support the BCOP standard natively, maybe there are some gaps on the implemented parser that will be refined with new test cases. We encourage you to report related **issues**!
 
 #### LLM-powered Parsers
 
-The library supports an optional parser option leveraging Large Language Model (LLM) to provide best-effort parsing when the specific parsers have not been successful.
+The library supports an optional parser option leveraging Large Language Models (LLM) to provide best-effort parsing when the specific parsers have not been successful.
 
 > Warning: Some of these integrations, such as OpenAI, require of extras installations parameters. Check the [extras section](#extras)
 
@@ -98,9 +110,12 @@ When the appropriate environment variable(s) are set (see below), these LLM pars
 
 These are the currently supported LLM integrations:
 
+- `PARSER_LLM_QUESTION_STR` (Optional), question to overwrite the default one. Change it carefully. It has precedence over `PARSER_LLM_QUESTION_FILEPATH`
+- `PARSER_LLM_QUESTION_FILEPATH` (Optional), a path to a file that contains a question to overwrite the default one.
+
 - [OpenAI](https://openai.com/product), these are the supported ENVs:
-  - `OPENAI_API_KEY` (Required): OpenAI API Key.
-  - `OPENAI_MODEL` (Optional): The LLM model to use, defaults to "gpt-3.5-turbo".
+  - `PARSER_OPENAI_API_KEY` (Required): OpenAI API Key.
+  - `PARSER_OPENAI_MODEL` (Optional): The LLM model to use, defaults to "gpt-3.5-turbo".
 
 ### Metadata
 

circuit_maintenance_parser/__init__.py

@@ -1,58 +1,75 @@
 """Circuit-maintenance-parser init."""
-from typing import Type, Optional
+
+from typing import Optional, Type
 
 from .data import NotificationData
-from .output import Maintenance
 from .errors import NonexistentProviderError, ProviderError
+from .output import Maintenance
 from .provider import (
-    GenericProvider,
-    AquaComms,
-    Arelion,
     AWS,
     BSO,
+    GTT,
+    HGC,
+    NTT,
+    AquaComms,
+    Apple,
+    Arelion,
     Cogent,
     Colt,
+    CrownCastle,
     Equinix,
     EUNetworks,
-    GTT,
-    HGC,
+    GenericProvider,
+    GlobalCloudXchange,
+    Google,
     Lumen,
     Megaport,
     Momentum,
-    NTT,
+    Netflix,
     PacketFabric,
+    PCCW,
     Seaborn,
     Sparkle,
+    Tata,
     Telia,
     Telstra,
     Turkcell,
     Verizon,
+    Windstream,
     Zayo,
 )
 
 SUPPORTED_PROVIDERS = (
     GenericProvider,
+    Apple,
     AquaComms,
     Arelion,
     AWS,
     BSO,
     Cogent,
     Colt,
+    CrownCastle,
     Equinix,
     EUNetworks,
+    GlobalCloudXchange,
+    Google,
     GTT,
     HGC,
     Lumen,
     Megaport,
     Momentum,
+    Netflix,
     NTT,
     PacketFabric,
+    PCCW,
     Seaborn,
     Sparkle,
+    Tata,
     Telia,
     Telstra,
     Turkcell,
     Verizon,
+    Windstream,
     Zayo,
 )
 
@@ -80,7 +97,6 @@ def get_provider_class(provider_name: str) -> Type[GenericProvider]:
         if provider_parser.get_provider_type() == provider_name:
             break
     else:
-
         raise NonexistentProviderError(
             f"{provider_name} is not a currently supported provider. Only {', '.join(SUPPORTED_PROVIDER_NAMES)}"
         )
@@ -90,7 +106,6 @@ def get_provider_class(provider_name: str) -> Type[GenericProvider]:
 
 def get_provider_class_from_sender(email_sender: str) -> Type[GenericProvider]:
     """Returns the notification parser class for an email sender address."""
-
     for provider_parser in SUPPORTED_PROVIDERS:
         if provider_parser.get_default_organizer() == email_sender:
             break

circuit_maintenance_parser/data.py

@@ -3,7 +3,7 @@
 from typing import List, NamedTuple, Optional, Type, Set
 
 import email
-from pydantic import BaseModel, Extra
+from pydantic import BaseModel
 from circuit_maintenance_parser.constants import EMAIL_HEADER_SUBJECT, EMAIL_HEADER_DATE
 
 
@@ -18,7 +18,7 @@ class DataPart(NamedTuple):
     content: bytes
 
 
-class NotificationData(BaseModel, extra=Extra.forbid):
+class NotificationData(BaseModel, extra="forbid"):
     """Base class for Notification Data types."""
 
     data_parts: List[DataPart] = []