######## Overview ########
WARNING: As previously announced on our communication channels, the Kytos project will enter the "shutdown" phase on May 31, 2021. After this date, only critical patches (security and core bug fixes) will be accepted, and the project will be in "critical-only" mode for another six months (until November 30, 2021). For more information visit the FAQ at https://kytos.io/faq. We'll have eternal gratitude to the entire community of developers and users that made the project so far.
|License| |Build| |Coverage| |Quality|
.. attention::
THIS NAPP IS STILL EXPERIMENTAL AND IT'S EVENTS, METHODS AND STRUCTURES MAY
CHANGE A LOT ON THE NEXT FEW DAYS/WEEKS, USE IT AT YOUR OWN DISCERNEMENTThe NApp kytos/pathfinder is a NApp responsible for creating a graph with the latest network topology and providing rest endpoint to calculate the best path between two devices. In the network, each device is a host or a switch and each link is a connection between two devices. In the graph, each device represents a node and each link represents an edge between two nodes.
The NApp learns custom properties from the topology, being able to define the best paths based on a weighted parmeter. Please see the Rest API documentation for details.
########## Installing ##########
All of the Kytos Network Applications are located in the NApps online repository. To install this NApp, run:
.. code:: shell
$ kytos napps install kytos/pathfinder
############ Requirements ############
Events
Listen
buffer: app
Listening on this event will make sure that this NApp has the lateste topology.
.. code-block:: python3
{
'topology':
######## Rest API ########
You can find a list of the available endpoints and example input/output in the
'REST API' tab in this NApp's webpage in the Kytos NApps Server <https://napps.kytos.io/kytos/pathfinder>_.
.. TAGs
.. |License| image:: https://img.shields.io/github/license/kytos/kytos.svg :target: https://github.com/kytos/ /blob/master/LICENSE .. |Build| image:: https://scrutinizer-ci.com/g/kytos/pathfinder/badges/build.png?b=master :alt: Build status :target: https://scrutinizer-ci.com/g/kytos/pathfinder/?branch=master .. |Coverage| image:: https://scrutinizer-ci.com/g/kytos/pathfinder/badges/coverage.png?b=master :alt: Code coverage :target: https://scrutinizer-ci.com/g/kytos/pathfinder/?branch=master .. |Quality| image:: https://scrutinizer-ci.com/g/kytos/pathfinder/badges/quality-score.png?b=master :alt: Code-quality score :target: https://scrutinizer-ci.com/g/kytos/pathfinder/?branch=master