nms-integration-tool 1.3.0.1__tar.gz

nms_integration_tool-1.3.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

nms_integration_tool-1.3.0.1/PKG-INFO

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: nms-integration-tool
+Version: 1.3.0.1
+Summary: Library to integrate Wirepas NMS metadata service APIs
+Author-email: Wirepas Oy <opensource@wirepas.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/wirepas/nms-integration-tool
+Keywords: wirepas,nms,integration,backend
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: attrs>=25.4.0
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: openpyxl>=3.1.5
+Requires-Dist: psycopg>=3.3.3
+Requires-Dist: requests>=2.32.5
+Provides-Extra: dev
+Requires-Dist: mockito>=2.0.1; extra == "dev"
+Requires-Dist: pytest>=9.0.2; extra == "dev"
+Requires-Dist: pytest-cov~=7.0.0; extra == "dev"
+Provides-Extra: examples
+Requires-Dist: click>=8.3.1; extra == "examples"
+Requires-Dist: schedule>=1.2.2; extra == "examples"
+Provides-Extra: api-gen
+Requires-Dist: openapi-python-client==0.28.3; extra == "api-gen"
+Dynamic: license-file
+
+# NMS Integration Tool
+
+This python package imports location, network, node, and gateway data into the associated Wirepas NMS backend metadata
+services.
+
+## Repository Organization
+
+### Python Package
+
+The `nms_integration_tool` package is organized as follows:
+
+- **[src/nms_integration_tool/](src/nms_integration_tool/)**
+    - **[api/](src/nms_integration_tool/api)** - OpenAPI generated NMS Metadata Service API Python libraries to connect
+      to and query services.
+    - **\<service name>/** - Contains requester/transformer module implementations for importing data to each service
+    - **[data_source.py](src/nms_integration_tool/data_source.py)** - Provides classes to extract data from various data
+      sources. These classes provide an `ingest` method that returns a list of data items. Future data sources can be
+      implemented using the `DataSource` interface.
+    - **[transformer.py](src/nms_integration_tool/transformer.py)** file defines a template class with methods to ingest
+      data from any data source. Each child class must provide a specific implementation detailing how input data is
+      transformed into a format compatible with the metadata APIs. The class provides methods that return a list of
+      transformed data items. Transformed data are represented as dictionaries with keys corresponding to the fields of
+      the associated metadata service objects, which can then be sent to the import module.
+    - **[requester.py](src/nms_integration_tool/requester.py)** file provides an interface class to import data and
+      update existing database records. Each service must implement the main function in its own child class inheriting
+      from this interface. The `import_data` method imports new data and updates existing records in the database. An
+      optional cache can be provided to store data from service responses.
+
+Classes are provided for importing locations, location types, networks, nodes, and gateway metadata.
+
+**Note:** For gateway, node, and location services, data with coordinates may be automatically updated with no actual
+changes. This occurs because services return non-identical data (the EPSG field is added to coordinates, and
+floating-point approximation errors can occur when comparing data source values with queried data). The import module
+detects these differences and updates records without modifying any fields, which may cause a small delay in POST
+queries.
+
+### WNT Metadata Exporter
+
+Helper script to import metadata from WNT to NMS:
+**[wnt_metadata_exporter.md](examples/wnt_migration/wnt_metadata_exporter.md)**
+
+### Example Scripts
+
+#### [data_import.md](examples/scripts/data_import.md)
+
+Helper script to import data from file sources to NMS with example [configs](examples/configs) to map data with NMS
+schemas.
+
+#### [postgres_import.md](examples/scripts/postgres_import.md)
+
+Basic and exemplary data importer from Postgres database to NMS.
+
+---
+
+## Requirements
+
+- [uv](https://docs.astral.sh/uv/) (recommended package manager)
+
+## Module Configuration
+
+Create a virtual environment and install the package using `uv`:
+
+```shell
+# Create venv and install package with all runtime dependencies
+uv sync
+
+# Install with examples dependencies (e.g. for running examples)
+uv sync --extra examples
+
+# or for all dependencies
+uv sync --all-extras
+
+# Install in editable mode for local development
+uv pip install -e .
+```
+
+## Installation
+
+### PyPI Installation
+
+```shell
+pip install nms-integration-tool
+```
+
+### Local Installation
+
+```shell
+# Install in editable mode for local development
+uv pip install -e .
+```
+
+# [LICENSE](LICENSE)
+
+---

nms_integration_tool-1.3.0.1/README.md

@@ -0,0 +1,94 @@
+# NMS Integration Tool
+
+This python package imports location, network, node, and gateway data into the associated Wirepas NMS backend metadata
+services.
+
+## Repository Organization
+
+### Python Package
+
+The `nms_integration_tool` package is organized as follows:
+
+- **[src/nms_integration_tool/](src/nms_integration_tool/)**
+    - **[api/](src/nms_integration_tool/api)** - OpenAPI generated NMS Metadata Service API Python libraries to connect
+      to and query services.
+    - **\<service name>/** - Contains requester/transformer module implementations for importing data to each service
+    - **[data_source.py](src/nms_integration_tool/data_source.py)** - Provides classes to extract data from various data
+      sources. These classes provide an `ingest` method that returns a list of data items. Future data sources can be
+      implemented using the `DataSource` interface.
+    - **[transformer.py](src/nms_integration_tool/transformer.py)** file defines a template class with methods to ingest
+      data from any data source. Each child class must provide a specific implementation detailing how input data is
+      transformed into a format compatible with the metadata APIs. The class provides methods that return a list of
+      transformed data items. Transformed data are represented as dictionaries with keys corresponding to the fields of
+      the associated metadata service objects, which can then be sent to the import module.
+    - **[requester.py](src/nms_integration_tool/requester.py)** file provides an interface class to import data and
+      update existing database records. Each service must implement the main function in its own child class inheriting
+      from this interface. The `import_data` method imports new data and updates existing records in the database. An
+      optional cache can be provided to store data from service responses.
+
+Classes are provided for importing locations, location types, networks, nodes, and gateway metadata.
+
+**Note:** For gateway, node, and location services, data with coordinates may be automatically updated with no actual
+changes. This occurs because services return non-identical data (the EPSG field is added to coordinates, and
+floating-point approximation errors can occur when comparing data source values with queried data). The import module
+detects these differences and updates records without modifying any fields, which may cause a small delay in POST
+queries.
+
+### WNT Metadata Exporter
+
+Helper script to import metadata from WNT to NMS:
+**[wnt_metadata_exporter.md](examples/wnt_migration/wnt_metadata_exporter.md)**
+
+### Example Scripts
+
+#### [data_import.md](examples/scripts/data_import.md)
+
+Helper script to import data from file sources to NMS with example [configs](examples/configs) to map data with NMS
+schemas.
+
+#### [postgres_import.md](examples/scripts/postgres_import.md)
+
+Basic and exemplary data importer from Postgres database to NMS.
+
+---
+
+## Requirements
+
+- [uv](https://docs.astral.sh/uv/) (recommended package manager)
+
+## Module Configuration
+
+Create a virtual environment and install the package using `uv`:
+
+```shell
+# Create venv and install package with all runtime dependencies
+uv sync
+
+# Install with examples dependencies (e.g. for running examples)
+uv sync --extra examples
+
+# or for all dependencies
+uv sync --all-extras
+
+# Install in editable mode for local development
+uv pip install -e .
+```
+
+## Installation
+
+### PyPI Installation
+
+```shell
+pip install nms-integration-tool
+```
+
+### Local Installation
+
+```shell
+# Install in editable mode for local development
+uv pip install -e .
+```
+
+# [LICENSE](LICENSE)
+
+---

nms_integration_tool-1.3.0.1/pyproject.toml

@@ -0,0 +1,76 @@
+# Copyright Wirepas Oy 2026 licensed under Apache 2.0
+#
+# Please see file LICENSE for full license details.
+
+[build-system]
+requires = ["setuptools==82.0.1", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["nms_integration_tool*"]
+
+[project]
+name = "nms-integration-tool"
+# pep-0440 valid, for version a.b.d.c, NMS version is <a.b.c> and nms-integration-tool version is <d>
+version = "1.3.0.1"
+description = "Library to integrate Wirepas NMS metadata service APIs"
+readme = "README.md"
+license = "Apache-2.0"
+authors = [
+    { name = "Wirepas Oy", email = "opensource@wirepas.com" },
+]
+keywords = ["wirepas", "nms", "integration", "backend"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+requires-python = ">=3.13"
+dependencies = [
+    "attrs>=25.4.0",
+    "httpx>=0.28.1",
+    "openpyxl>=3.1.5",
+    "psycopg>=3.3.3",
+    "requests>=2.32.5",
+]
+
+
+[project.urls]
+Repository = "https://github.com/wirepas/nms-integration-tool"
+
+
+[project.optional-dependencies]
+dev = [
+    "mockito>=2.0.1",
+    "pytest>=9.0.2",
+    "pytest-cov~=7.0.0",
+]
+examples = [
+    "click>=8.3.1",
+    "schedule>=1.2.2"
+]
+api-gen = [
+    "openapi-python-client==0.28.3",
+]
+
+
+[tool.uv]
+python-preference = "managed"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["nms_integration_tool"]
+omit = ["*/api/*"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.ruff]
+target-version = "py314"
+line-length = 100

nms_integration_tool-1.3.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

nms_integration_tool-1.3.0.1/src/nms_integration_tool/__init__.py

@@ -0,0 +1,6 @@
+from .api import *
+from .locations import *
+from .networks import *
+from .nodes import *
+from .gateways import *
+from . import api_client, cache, data_source

nms_integration_tool-1.3.0.1/src/nms_integration_tool/api/__init__.py

@@ -0,0 +1,4 @@
+from .gateways.wirepas_gateway_metadata_service_api_client import *
+from .locations.wirepas_locations_metadata_service_api_client import *
+from .networks.wm_network_metadata_service_api_client import *
+from .nodes.wm_node_metadata_service_api_client import *

nms_integration_tool-1.3.0.1/src/nms_integration_tool/api/gateways/wirepas_gateway_metadata_service_api_client/__init__.py

@@ -0,0 +1,8 @@
+"""A client library for accessing Wirepas gateway metadata service API"""
+
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

nms_integration_tool-1.3.0.1/src/nms_integration_tool/api/gateways/wirepas_gateway_metadata_service_api_client/api/__init__.py

@@ -0,0 +1 @@
+"""Contains methods for accessing the API"""

nms_integration_tool-1.3.0.1/src/nms_integration_tool/api/gateways/wirepas_gateway_metadata_service_api_client/api/gateway_metadata/__init__.py

@@ -0,0 +1,10 @@
+from .get_gateways import *
+from .delete_gateway import *
+from .update_gateway import *
+from .patch_gateway import *
+from .refresh_gateway_by_uuid import *
+from .patch_gateways import *
+from .search_gateways import *
+from .create_gateways import *
+from .get_gateway_by_uuid import *
+from .delete_gateways import *