gnpy-api 0.1.2__tar.gz → 0.2.0__tar.gz

{gnpy_api-0.1.2 → gnpy_api-0.2.0}/.github/workflows/main.yml

@@ -109,17 +109,18 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - os: windows-2019
-            python_version: "3.10"
           - os: windows-2022
             python_version: "3.11"
           - os: windows-2022
             python_version: "3.12"
-          - os: macos-13
+          - os: windows-2025
+            python_version: "3.11"
+          - os: windows-2025
             python_version: "3.12"
           - os: macos-14
             python_version: "3.12"
-
+          - os: macos-15
+            python_version: "3.12"
   paywalled-platforms:
     name: Tests on paywalled platforms
     if: github.repository_owner == 'Telecominfraproject'
@@ -138,5 +139,5 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - os: macos-13-xlarge # Apple M1 CPU
+          - os: macos-14-xlarge # Apple M1 CPU
             python_version: "3.12"

gnpy_api-0.2.0/AUTHORS

@@ -0,0 +1 @@
+Renato Ambrosone <renato.ambrosone@polito.it>

gnpy_api-0.2.0/ChangeLog

@@ -0,0 +1,7 @@
+CHANGES
+=======
+
+v0.2.0
+------
+
+* README update for release 0.2

gnpy_api-0.2.0/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: gnpy-api
+Version: 0.2.0
+Home-page: https://github.com/Telecominfraproject/oopt-gnpy-api
+Author: Telecom Infra Project
+Author-email: adamico@nec-labs.com
+License: BSD-3-Clause
+Project-URL: Bug Tracker, https://github.com/Telecominfraproject/oopt-gnpy-api/issues
+Project-URL: Documentation, https://gnpyapi.readthedocs.io/
+Keywords: optics,network,fiber,communication,route,planning,optimization,api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; variant=GFM
+License-File: LICENSE
+Requires-Dist: setuptools
+Requires-Dist: gnpy==2.14
+Requires-Dist: flask>=1.1.2
+Requires-Dist: Flask-Injector
+Requires-Dist: pyopenssl==25.0.0
+Provides-Extra: tests
+Requires-Dist: build<2,>=1.0.3; extra == "tests"
+Requires-Dist: pytest<8,>=7.4.3; extra == "tests"
+Requires-Dist: pyang<3,>=2.6.1; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: alabaster<1,>=0.7.12; extra == "docs"
+Requires-Dist: docutils<1,>=0.17.1; extra == "docs"
+Requires-Dist: myst-parser<1,>=0.16.1; extra == "docs"
+Requires-Dist: Pygments<3,>=2.11.2; extra == "docs"
+Requires-Dist: rstcheck; extra == "docs"
+Requires-Dist: Sphinx<6,>=5.3.0; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex<3,>=2.4.1; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-python
+
+# GNPy API
+[![Install via pip](https://img.shields.io/pypi/v/gnpy-api)](https://pypi.org/project/gnpy-api/)
+[![Python versions](https://img.shields.io/pypi/pyversions/gnpy-api)](https://pypi.org/project/gnpy-api/)
+[![Gerrit](https://img.shields.io/badge/patches-via%20Gerrit-blue)](https://review.gerrithub.io/q/project:Telecominfraproject/oopt-gnpy-api)
+
+REST API (experimental)
+-----------------------
+This repository extends GNPy with additional interfaces, allowing for more flexible control and interaction with its simulation engine. These interfaces can be used to integrate GNPy into software-defined networking (SDN) architectures or other external applications.
+
+[GNPy](https://github.com/Telecominfraproject/oopt-gnpy) is an open-source Python-based library that models and evaluates the performance of optical networks. It is widely used for path computation, QoT (Quality of Transmission) estimation, and network planning.
+
+## 🚀 Installation
+### Build from Source - Option 1
+Clone the repository and install the package:
+```bash
+python3 setup.py install
+```
+or if you want to install it in a docker container:
+```bash
+docker docker build ./ -t gnpy-api
+```
+
+### PiPy - Option 2
+```bash
+pip install gnpy-api
+```
+
+
+### DockerHub - Option 3
+Coming.... 
+## Quick Start
+
+## 🧪 Usage - CLI
+Start the REST API server:
+```bash
+python ./samples/rest_example.py
+```
+See the help for the REST API:
+```bash
+python ./samples/rest_example.py -h
+```
+Send example data to the REST API:
+```bash
+curl --location 'https://localhost:8080/api/v0.1/path-request' --header 'Content-Type: application/json' --data @gnpyapi/exampledata/planning_demand_example.json -k
+```
+## 🧪 Usage - Docker
+
+
+
+## 🔄 Compatibility
+
+Different versions of this interface extension are compatible with specific versions of [GNPy](https://github.com/Telecominfraproject/oopt-gnpy). Please refer to the table below to ensure that you are using a supported version combination.
+
+
+
+| Interface Version | Compatible GNPy Version | Notes                          |
+|-------------------|-----------------|--------------------------------|
+| `v0.2.x`          | `>=2.14  `      | YANG model validation          |
+| `v0.1.x`          | `>=2.12.1`      | Initial release                |
+
+⚠️ If you use an incompatible combination, some features may not work correctly or may produce unexpected errors.
+
+To check your GNPy version, run:
+
+```bash
+pip show gnpy
+```
+
+## 📚 Documentation
+Refer to the official [GNPy documentation](https://github.com/Telecominfraproject/oopt-gnpy/tree/master/docs) for information about network modeling and simulation capabilities.
+
+API documentation is available in the docs folder.
+

gnpy_api-0.2.0/README.md

@@ -0,0 +1,72 @@
+# GNPy API
+[![Install via pip](https://img.shields.io/pypi/v/gnpy-api)](https://pypi.org/project/gnpy-api/)
+[![Python versions](https://img.shields.io/pypi/pyversions/gnpy-api)](https://pypi.org/project/gnpy-api/)
+[![Gerrit](https://img.shields.io/badge/patches-via%20Gerrit-blue)](https://review.gerrithub.io/q/project:Telecominfraproject/oopt-gnpy-api)
+
+REST API (experimental)
+-----------------------
+This repository extends GNPy with additional interfaces, allowing for more flexible control and interaction with its simulation engine. These interfaces can be used to integrate GNPy into software-defined networking (SDN) architectures or other external applications.
+
+[GNPy](https://github.com/Telecominfraproject/oopt-gnpy) is an open-source Python-based library that models and evaluates the performance of optical networks. It is widely used for path computation, QoT (Quality of Transmission) estimation, and network planning.
+
+## 🚀 Installation
+### Build from Source - Option 1
+Clone the repository and install the package:
+```bash
+python3 setup.py install
+```
+or if you want to install it in a docker container:
+```bash
+docker docker build ./ -t gnpy-api
+```
+
+### PiPy - Option 2
+```bash
+pip install gnpy-api
+```
+
+
+### DockerHub - Option 3
+Coming.... 
+## Quick Start
+
+## 🧪 Usage - CLI
+Start the REST API server:
+```bash
+python ./samples/rest_example.py
+```
+See the help for the REST API:
+```bash
+python ./samples/rest_example.py -h
+```
+Send example data to the REST API:
+```bash
+curl --location 'https://localhost:8080/api/v0.1/path-request' --header 'Content-Type: application/json' --data @gnpyapi/exampledata/planning_demand_example.json -k
+```
+## 🧪 Usage - Docker
+
+
+
+## 🔄 Compatibility
+
+Different versions of this interface extension are compatible with specific versions of [GNPy](https://github.com/Telecominfraproject/oopt-gnpy). Please refer to the table below to ensure that you are using a supported version combination.
+
+
+
+| Interface Version | Compatible GNPy Version | Notes                          |
+|-------------------|-----------------|--------------------------------|
+| `v0.2.x`          | `>=2.14  `      | YANG model validation          |
+| `v0.1.x`          | `>=2.12.1`      | Initial release                |
+
+⚠️ If you use an incompatible combination, some features may not work correctly or may produce unexpected errors.
+
+To check your GNPy version, run:
+
+```bash
+pip show gnpy
+```
+
+## 📚 Documentation
+Refer to the official [GNPy documentation](https://github.com/Telecominfraproject/oopt-gnpy/tree/master/docs) for information about network modeling and simulation capabilities.
+
+API documentation is available in the docs folder.

gnpy_api-0.2.0/gnpy_api.egg-info/PKG-INFO

@@ -0,0 +1,132 @@
+Metadata-Version: 2.4
+Name: gnpy-api
+Version: 0.2.0
+Home-page: https://github.com/Telecominfraproject/oopt-gnpy-api
+Author: Telecom Infra Project
+Author-email: adamico@nec-labs.com
+License: BSD-3-Clause
+Project-URL: Bug Tracker, https://github.com/Telecominfraproject/oopt-gnpy-api/issues
+Project-URL: Documentation, https://gnpyapi.readthedocs.io/
+Keywords: optics,network,fiber,communication,route,planning,optimization,api
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Telecommunications Industry
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown; variant=GFM
+License-File: LICENSE
+Requires-Dist: setuptools
+Requires-Dist: gnpy==2.14
+Requires-Dist: flask>=1.1.2
+Requires-Dist: Flask-Injector
+Requires-Dist: pyopenssl==25.0.0
+Provides-Extra: tests
+Requires-Dist: build<2,>=1.0.3; extra == "tests"
+Requires-Dist: pytest<8,>=7.4.3; extra == "tests"
+Requires-Dist: pyang<3,>=2.6.1; extra == "tests"
+Provides-Extra: docs
+Requires-Dist: alabaster<1,>=0.7.12; extra == "docs"
+Requires-Dist: docutils<1,>=0.17.1; extra == "docs"
+Requires-Dist: myst-parser<1,>=0.16.1; extra == "docs"
+Requires-Dist: Pygments<3,>=2.11.2; extra == "docs"
+Requires-Dist: rstcheck; extra == "docs"
+Requires-Dist: Sphinx<6,>=5.3.0; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex<3,>=2.4.1; extra == "docs"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-python
+
+# GNPy API
+[![Install via pip](https://img.shields.io/pypi/v/gnpy-api)](https://pypi.org/project/gnpy-api/)
+[![Python versions](https://img.shields.io/pypi/pyversions/gnpy-api)](https://pypi.org/project/gnpy-api/)
+[![Gerrit](https://img.shields.io/badge/patches-via%20Gerrit-blue)](https://review.gerrithub.io/q/project:Telecominfraproject/oopt-gnpy-api)
+
+REST API (experimental)
+-----------------------
+This repository extends GNPy with additional interfaces, allowing for more flexible control and interaction with its simulation engine. These interfaces can be used to integrate GNPy into software-defined networking (SDN) architectures or other external applications.
+
+[GNPy](https://github.com/Telecominfraproject/oopt-gnpy) is an open-source Python-based library that models and evaluates the performance of optical networks. It is widely used for path computation, QoT (Quality of Transmission) estimation, and network planning.
+
+## 🚀 Installation
+### Build from Source - Option 1
+Clone the repository and install the package:
+```bash
+python3 setup.py install
+```
+or if you want to install it in a docker container:
+```bash
+docker docker build ./ -t gnpy-api
+```
+
+### PiPy - Option 2
+```bash
+pip install gnpy-api
+```
+
+
+### DockerHub - Option 3
+Coming.... 
+## Quick Start
+
+## 🧪 Usage - CLI
+Start the REST API server:
+```bash
+python ./samples/rest_example.py
+```
+See the help for the REST API:
+```bash
+python ./samples/rest_example.py -h
+```
+Send example data to the REST API:
+```bash
+curl --location 'https://localhost:8080/api/v0.1/path-request' --header 'Content-Type: application/json' --data @gnpyapi/exampledata/planning_demand_example.json -k
+```
+## 🧪 Usage - Docker
+
+
+
+## 🔄 Compatibility
+
+Different versions of this interface extension are compatible with specific versions of [GNPy](https://github.com/Telecominfraproject/oopt-gnpy). Please refer to the table below to ensure that you are using a supported version combination.
+
+
+
+| Interface Version | Compatible GNPy Version | Notes                          |
+|-------------------|-----------------|--------------------------------|
+| `v0.2.x`          | `>=2.14  `      | YANG model validation          |
+| `v0.1.x`          | `>=2.12.1`      | Initial release                |
+
+⚠️ If you use an incompatible combination, some features may not work correctly or may produce unexpected errors.
+
+To check your GNPy version, run:
+
+```bash
+pip show gnpy
+```
+
+## 📚 Documentation
+Refer to the official [GNPy documentation](https://github.com/Telecominfraproject/oopt-gnpy/tree/master/docs) for information about network modeling and simulation capabilities.
+
+API documentation is available in the docs folder.
+

{gnpy_api-0.1.2 → gnpy_api-0.2.0}/gnpy_api.egg-info/SOURCES.txt

@@ -42,24 +42,17 @@ gnpyapi/core/service/path_request_service.py
 gnpyapi/core/service/topology_service.py
 gnpyapi/exampledata/planning_demand_example.json
 gnpyapi/tools/__init__.py
-gnpyapi/yang/gnpy-api@2021-01-06.yang
-gnpyapi/yang/gnpy-eqpt-config@2020-10-22.yang
-gnpyapi/yang/gnpy-eqpt-config@2025-01-20.yang
-gnpyapi/yang/gnpy-network-topology@2020-10-22.yang
-gnpyapi/yang/gnpy-network-topology@2025-01-20.yang
-gnpyapi/yang/gnpy-path-computation-simplified@2020-10-22.yang
-gnpyapi/yang/gnpy-path-computation@2025-01-21.yang
-gnpyapi/yang/ietf-layer0-types@2024-03-04.yang
-gnpyapi/yang/ietf-optical-impairment-topology@2024-05-21.yang
-gnpyapi/yang/ietf-routing-types@2017-12-04.yang
-gnpyapi/yang/ietf-te-topology@2020-08-06.yang
-gnpyapi/yang/ietf-te-types@2022-10-21.yang
 samples/rest_example.py
 tests/__init__.py
 tests/test_api.py
 tests/data/req/planning_demand_example.json
 tests/data/req/planning_demand_wrong_eqpt.json
 tests/data/req/planning_demand_wrong_topology.json
+tests/data/req/legacy/planning_demand_example.json
+tests/data/req/legacy/planning_demand_wrong_eqpt.json
+tests/data/req/legacy/planning_demand_wrong_topology.json
 tests/data/res/planning_demand_res.json
 tests/service/__init__.py
-tests/service/test_path_request_service.py
+tests/service/test_path_request_service.py
+tests/utils/__init__.py
+tests/utils/input.py

gnpy_api-0.2.0/gnpy_api.egg-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "33ed765", "is_release": false}

{gnpy_api-0.1.2 → gnpy_api-0.2.0}/gnpy_api.egg-info/requires.txt

@@ -1,5 +1,5 @@
 setuptools
-gnpy==2.12.1
+gnpy==2.14
 flask>=1.1.2
 Flask-Injector
 pyopenssl==25.0.0

{gnpy_api-0.1.2 → gnpy_api-0.2.0}/gnpyapi/core/__init__.py

@@ -4,7 +4,7 @@
 """
 from flask import Flask
 
-API_VERSION = "/api/v0.1"
+API_VERSION = "/api/v0.2"
 
 app = Flask(__name__)
 

gnpy_api-0.2.0/gnpyapi/core/route/path_request_route.py

@@ -0,0 +1,36 @@
+# coding: utf-8
+import json
+
+from flask import request
+
+from gnpyapi.core import app
+from gnpyapi.core.exception.equipment_error import EquipmentError
+from gnpyapi.core.exception.topology_error import TopologyError
+from gnpyapi.core.service.path_request_service import PathRequestService
+from gnpy.tools.convert_legacy_yang import yang_to_legacy
+from gnpyapi.core import API_VERSION
+
+PATH_REQUEST_BASE_PATH = '/path-request'
+
+
+@app.route(API_VERSION + PATH_REQUEST_BASE_PATH, methods=['POST'])
+def path_request(path_request_service: PathRequestService):
+    is_legacy = 'gnpy-api:api' not in request.json
+    if not is_legacy:
+        legacy_data = yang_to_legacy(json.loads(request.json))
+        service = legacy_data['gnpy-path-computation:services']
+        topology = legacy_data['gnpy-network-topology:topology']
+        equipment = yang_to_legacy(json.loads(request.json)["gnpy-api:api"]['gnpy-eqpt-config:equipment'])
+    else:
+        data = request.json
+        service = data['gnpy-api:service']
+        if 'gnpy-api:topology' in data:
+            topology = data['gnpy-api:topology']
+        else:
+            raise TopologyError('No topology found in request')
+        if 'gnpy-api:equipment' in data:
+            equipment = data['gnpy-api:equipment']
+        else:
+            raise EquipmentError('No equipment found in request')
+
+    return path_request_service.path_request(topology, equipment, service), 201

{gnpy_api-0.1.2 → gnpy_api-0.2.0}/gnpyapi/core/route/status_route.py

@@ -5,4 +5,4 @@ from gnpyapi.core import API_VERSION
 
 @app.route(API_VERSION + '/status', methods=['GET'])
 def api_status():
-    return {"version": "v0.1", "status": "ok"}, 200
+    return {"version": f"{API_VERSION}", "status": "ok"}, 200

{gnpy_api-0.1.2 → gnpy_api-0.2.0}/gnpyapi/core/service/path_request_service.py

@@ -6,7 +6,6 @@ from gnpy.core.exceptions import EquipmentConfigError, NetworkTopologyError
 from gnpy.tools.json_io import results_to_json, load_eqpt_topo_from_json
 from gnpy.tools.worker_utils import designed_network, planning
 from gnpyapi.core.exception.topology_error import TopologyError
-
 from gnpyapi.core.exception.equipment_error import EquipmentError
 
 _logger = logging.getLogger(__name__)