Metadata-Version: 2.4
Name: gnpy-api
Version: 0.1.2
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.12.1
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
[![Python versions](https://img.shields.io/pypi/pyversions/gnpy)](https://pypi.org/project/gnpy/)

REST API (experimental)
-----------------------
``gnpyapi`` provides an experimental api for requesting several paths at once. It is based on Flask server.
You can run it through command line or Docker.



    $ curl --location 'http://localhost:8080/api/v1/path-request' --header 'Content-Type: application/json' --data @gnpyapi/exampledata/planning_demand_example.json 

TODO: api documentation, unit tests, real WSGI server with trusted certificates

## Quick Start

tbd

