topolib 0.4.1__tar.gz → 0.5.0__tar.gz

{topolib-0.4.1 → topolib-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: topolib
-Version: 0.4.1
+Version: 0.5.0
 Summary: A compact Python library for modeling, analyzing, and visualizing optical network topologies.
 License: MIT
 License-File: LICENSE
@@ -21,6 +21,7 @@ Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: contextily
 Requires-Dist: geopandas
+Requires-Dist: jsonschema (>=4.0)
 Requires-Dist: matplotlib
 Requires-Dist: networkx (>=2.6)
 Requires-Dist: numpy (>=1.21)
@@ -31,7 +32,7 @@ Project-URL: Repository, https://gitlab.com/DaniloBorquez/topolib
 Description-Content-Type: text/markdown
 
 # Topolib 🚀
-
+# Topolib 🚀
 
 [![Python Version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/)
 [![License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](LICENSE)
@@ -40,99 +41,81 @@ Description-Content-Type: text/markdown
 [![Release coverage](https://gitlab.com/DaniloBorquez/topolib/badges/release/coverage.svg)](https://gitlab.com/DaniloBorquez/topolib/-/pipelines?ref=release)
 [![Documentation Status](https://readthedocs.org/projects/topolib/badge/?version=latest)](https://topolib.readthedocs.io/en/latest/?badge=latest)
 
-A compact Python library for working with optical network topologies: nodes, links, metrics and visualization tools. 🌐
+> **Topolib** is a compact, modular Python library for modeling, analyzing, and visualizing optical network topologies.  
+> **Goal:** Provide researchers and engineers with a simple, extensible toolkit for working with nodes, links, metrics, and map-based visualizations.  
+>   
+> 🌐 **Model** | 📊 **Analyze** | 🗺️ **Visualize** | 🧩 **Extend**
+
+---
 
-## Overview
+## 📂 Examples
 
-Topolib models network topologies with three main modules:
+Explore ready-to-run usage examples in the [`examples/`](examples/) folder!  
+- [Show topology on a map](examples/show_topology_in_map.py) 🗺️  
+- [Export topology to CSV and JSON](examples/export_csv_json.py) 📄
+- [Export topology and k-shortest paths for FlexNetSim](examples/export_flexnetsim.py) 🔀
 
-- `topolib.elements` — Definitions of elementary building blocks
-  - `Node` — represents a network node with id, name and geographic coordinates
-  - `Link` — connects two `Node` objects and stores link length and id
+---
 
-- `topolib.topology` — High-level topology model
-  - `Topology` — holds nodes and links, provides methods to add/remove nodes and links, compute metrics, export JSON, and compute shortest/disjoint paths
-  - `Path` — represents a path through the topology
+## 🧭 Overview
 
-- `topolib.analysis` — Metrics and analysis helpers
-  - `Metrics` — functions to compute node degree, link length statistics, connection matrices, etc.
+Topolib is organized into four main modules:
 
-- `topolib.visualization` — Visualization helpers
-  - `MapView` — functions to display topology with OSM or paper-style maps
+- 🧱 **Elements:** `Node`, `Link` — basic building blocks
+- 🕸️ **Topology:** `Topology`, `Path` — manage nodes, links, paths, and adjacency
+- 📈 **Analysis:** `Metrics` — compute node degree, link stats, connection matrices
+- 🖼️ **Visualization:** `MapView` — plot topologies on real maps
 
-(These components are derived from the project's class diagram in `diagrams/class_diagram.puml`.)
+---
 
-## Features
-- Modular design: elements, topology, analysis, and visualization
+## ✨ Features
+
+- Modular, extensible design
 - Easy-to-use classes for nodes, links, and paths
 - Built-in metrics and analysis helpers
 - JSON import/export and interoperability
 - Ready for Sphinx, Read the Docs, and PyPI
 
-## Quickstart ⚡
+---
 
-Create and activate a virtual environment, install dev dependencies and run tests:
+## ⚡ Quickstart
 
 ```bash
 python -m venv .venv
 source .venv/bin/activate
-python -m pip install -U pip
-python -m pip install -r dev-requirements.txt
-python -m pytest -q
-```
-
-## Installation
-
-```bash
+pip install -U pip
 pip install topolib
 ```
 
-Or for development:
+---
 
-```bash
-git clone https://gitlab.com/DaniloBorquez/topolib.git
-cd topolib
-python -m venv .venv
-source .venv/bin/activate
-pip install -e .
-pip install -r dev-requirements.txt
-```
-
-## Documentation
+## 📚 Documentation
 
 Full documentation: [https://topolib.readthedocs.io/](https://topolib.readthedocs.io/)
 
-## Basic usage example
+---
 
-```py
+## 📝 Basic usage
+
+```python
 from topolib.elements.node import Node
 from topolib.topology.topology import Topology
 
-# Create nodes
 n1 = Node(1, 'A', 10.0, 20.0)
 n2 = Node(2, 'B', 11.0, 21.0)
-
-# Build topology
-topo = Topology()
-topo.add_node(n1)
-topo.add_node(n2)
-# add links, compute metrics, visualize
+topo = Topology(nodes=[n1, n2])
+# Add links, compute metrics, visualize, etc.
 ```
 
+---
 
-## Development 🛠️
-
-See `CONTRIBUTING.md` for development guidelines, commit message rules and pre-commit setup.
-
-
-
-## Class diagram
+## 🛠️ Development
 
-![](diagrams/class_diagram.puml)
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for development guidelines, commit message rules, and pre-commit setup.
 
-(If you prefer a rendered image of the UML, render the PlantUML file locally or in your CI pipeline.)
+---
 
-## License
+## 📄 License
 
-See `LICENSE` in the project root.
+MIT — see [`LICENSE`](LICENSE) for details.
 

topolib-0.5.0/README.md

@@ -0,0 +1,87 @@
+# Topolib 🚀
+# Topolib 🚀
+
+[![Python Version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/)
+[![License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](LICENSE)
+[![Issues](https://img.shields.io/badge/issues-on%20GitLab-blue.svg)](https://gitlab.com/DaniloBorquez/topolib/-/issues)
+[![Develop coverage](https://gitlab.com/DaniloBorquez/topolib/badges/develop/coverage.svg)](https://gitlab.com/DaniloBorquez/topolib/-/pipelines?ref=develop)
+[![Release coverage](https://gitlab.com/DaniloBorquez/topolib/badges/release/coverage.svg)](https://gitlab.com/DaniloBorquez/topolib/-/pipelines?ref=release)
+[![Documentation Status](https://readthedocs.org/projects/topolib/badge/?version=latest)](https://topolib.readthedocs.io/en/latest/?badge=latest)
+
+> **Topolib** is a compact, modular Python library for modeling, analyzing, and visualizing optical network topologies.  
+> **Goal:** Provide researchers and engineers with a simple, extensible toolkit for working with nodes, links, metrics, and map-based visualizations.  
+>   
+> 🌐 **Model** | 📊 **Analyze** | 🗺️ **Visualize** | 🧩 **Extend**
+
+---
+
+## 📂 Examples
+
+Explore ready-to-run usage examples in the [`examples/`](examples/) folder!  
+- [Show topology on a map](examples/show_topology_in_map.py) 🗺️  
+- [Export topology to CSV and JSON](examples/export_csv_json.py) 📄
+- [Export topology and k-shortest paths for FlexNetSim](examples/export_flexnetsim.py) 🔀
+
+---
+
+## 🧭 Overview
+
+Topolib is organized into four main modules:
+
+- 🧱 **Elements:** `Node`, `Link` — basic building blocks
+- 🕸️ **Topology:** `Topology`, `Path` — manage nodes, links, paths, and adjacency
+- 📈 **Analysis:** `Metrics` — compute node degree, link stats, connection matrices
+- 🖼️ **Visualization:** `MapView` — plot topologies on real maps
+
+---
+
+## ✨ Features
+
+- Modular, extensible design
+- Easy-to-use classes for nodes, links, and paths
+- Built-in metrics and analysis helpers
+- JSON import/export and interoperability
+- Ready for Sphinx, Read the Docs, and PyPI
+
+---
+
+## ⚡ Quickstart
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -U pip
+pip install topolib
+```
+
+---
+
+## 📚 Documentation
+
+Full documentation: [https://topolib.readthedocs.io/](https://topolib.readthedocs.io/)
+
+---
+
+## 📝 Basic usage
+
+```python
+from topolib.elements.node import Node
+from topolib.topology.topology import Topology
+
+n1 = Node(1, 'A', 10.0, 20.0)
+n2 = Node(2, 'B', 11.0, 21.0)
+topo = Topology(nodes=[n1, n2])
+# Add links, compute metrics, visualize, etc.
+```
+
+---
+
+## 🛠️ Development
+
+See [`CONTRIBUTING.md`](CONTRIBUTING.md) for development guidelines, commit message rules, and pre-commit setup.
+
+---
+
+## 📄 License
+
+MIT — see [`LICENSE`](LICENSE) for details.

{topolib-0.4.1 → topolib-0.5.0}/pyproject.toml

@@ -2,7 +2,7 @@
 [tool.poetry]
 name = "topolib"
 # Poetry requires a version field, but poetry-dynamic-versioning will override it
-version = "0.4.1"
+version = "0.5.0"
 description = "A compact Python library for modeling, analyzing, and visualizing optical network topologies."
 authors = ["Danilo Bórquez-Paredes <danilo.borquez.p@uai.cl>"]
 license = "MIT"
@@ -30,6 +30,9 @@ matplotlib = "*"
 contextily = "*"
 geopandas = "*"
 shapely = "*"
+jsonschema = ">=4.0"
+
+## Ensures interactive backend for matplotlib
 
 
 [tool.poetry.group.dev.dependencies]
@@ -39,6 +42,9 @@ matplotlib = "*"
 contextily = "*"
 geopandas = "*"
 shapely = "*"
+jsonschema = ">=4.0"
+
+## Ensures interactive backend for matplotlib in development
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

{topolib-0.4.1 → topolib-0.5.0}/topolib/analysis/metrics.py

@@ -2,7 +2,7 @@
 Metrics module for network topology analysis.
 """
 
-from typing import List, Any, Dict, Optional
+from typing import List, Dict, Optional
 
 
 from topolib.topology import Topology
@@ -12,16 +12,16 @@ class Metrics:
     """
     Provides static methods for computing metrics on network topologies.
 
-    Todos los métodos reciben una instancia de Topology.
+    All methods receive a Topology instance.
 
-    Métodos
+    Methods
     -------
     node_degree(topology)
-        Calcula el grado de cada nodo.
+        Calculates the degree of each node.
     link_length_stats(topology)
-        Calcula estadísticas (min, max, avg) de las longitudes de los enlaces.
+        Calculates statistics (min, max, avg) of link lengths.
     connection_matrix(topology)
-        Construye la matriz de adyacencia.
+        Builds the adjacency matrix.
     """
 
     @staticmethod