topolib 0.3.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of topolib might be problematic. Click here for more details.

@@ -1,127 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: topolib
3
- Version: 0.3.0
4
- Summary: A compact Python library for modeling, analyzing, and visualizing optical network topologies.
5
- Author-email: Danilo Bórquez-Paredes <danilo.borquez.p@uai.cl>
6
- License-Expression: MIT
7
- Project-URL: Homepage, https://gitlab.com/DaniloBorquez/topolib
8
- Project-URL: Documentation, https://topolib.readthedocs.io/
9
- Project-URL: Source, https://gitlab.com/DaniloBorquez/topolib
10
- Project-URL: Issues, https://gitlab.com/DaniloBorquez/topolib/-/issues
11
- Classifier: Programming Language :: Python :: 3
12
- Classifier: Operating System :: OS Independent
13
- Classifier: Intended Audience :: Science/Research
14
- Classifier: Topic :: Scientific/Engineering :: Information Analysis
15
- Classifier: Topic :: Software Development :: Libraries :: Python Modules
16
- Requires-Python: >=3.10
17
- Description-Content-Type: text/markdown
18
- License-File: LICENSE
19
- Requires-Dist: numpy>=1.21
20
- Requires-Dist: networkx>=2.6
21
- Dynamic: license-file
22
-
23
- # Topolib 🚀
24
-
25
-
26
- [![Python Version](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/)
27
- [![License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](LICENSE)
28
- [![Issues](https://img.shields.io/badge/issues-on%20GitLab-blue.svg)](https://gitlab.com/DaniloBorquez/topolib/-/issues)
29
- [![Develop coverage](https://gitlab.com/DaniloBorquez/topolib/badges/develop/coverage.svg)](https://gitlab.com/DaniloBorquez/topolib/-/pipelines?ref=develop)
30
- [![Release coverage](https://gitlab.com/DaniloBorquez/topolib/badges/release/coverage.svg)](https://gitlab.com/DaniloBorquez/topolib/-/pipelines?ref=release)
31
- [![Documentation Status](https://readthedocs.org/projects/topolib/badge/?version=latest)](https://topolib.readthedocs.io/en/latest/?badge=latest)
32
-
33
- A compact Python library for working with optical network topologies: nodes, links, metrics and visualization tools. 🌐
34
-
35
- ## Overview
36
-
37
- Topolib models network topologies with three main modules:
38
-
39
- - `topolib.elements` — Definitions of elementary building blocks
40
- - `Node` — represents a network node with id, name and geographic coordinates
41
- - `Link` — connects two `Node` objects and stores link length and id
42
-
43
- - `topolib.topology` — High-level topology model
44
- - `Topology` — holds nodes and links, provides methods to add/remove nodes and links, compute metrics, export JSON, and compute shortest/disjoint paths
45
- - `Path` — represents a path through the topology
46
-
47
- - `topolib.analysis` — Metrics and analysis helpers
48
- - `Metrics` — functions to compute node degree, link length statistics, connection matrices, etc.
49
-
50
- - `topolib.visualization` — Visualization helpers
51
- - `MapView` — functions to display topology with OSM or paper-style maps
52
-
53
- (These components are derived from the project's class diagram in `diagrams/class_diagram.puml`.)
54
-
55
- ## Features
56
- - Modular design: elements, topology, analysis, and visualization
57
- - Easy-to-use classes for nodes, links, and paths
58
- - Built-in metrics and analysis helpers
59
- - JSON import/export and interoperability
60
- - Ready for Sphinx, Read the Docs, and PyPI
61
-
62
- ## Quickstart ⚡
63
-
64
- Create and activate a virtual environment, install dev dependencies and run tests:
65
-
66
- ```bash
67
- python -m venv .venv
68
- source .venv/bin/activate
69
- python -m pip install -U pip
70
- python -m pip install -r dev-requirements.txt
71
- python -m pytest -q
72
- ```
73
-
74
- ## Installation
75
-
76
- ```bash
77
- pip install topolib
78
- ```
79
-
80
- Or for development:
81
-
82
- ```bash
83
- git clone https://gitlab.com/DaniloBorquez/topolib.git
84
- cd topolib
85
- python -m venv .venv
86
- source .venv/bin/activate
87
- pip install -e .
88
- pip install -r dev-requirements.txt
89
- ```
90
-
91
- ## Documentation
92
-
93
- Full documentation: [https://topolib.readthedocs.io/](https://topolib.readthedocs.io/)
94
-
95
- ## Basic usage example
96
-
97
- ```py
98
- from topolib.elements.node import Node
99
- from topolib.topology.topology import Topology
100
-
101
- # Create nodes
102
- n1 = Node(1, 'A', 10.0, 20.0)
103
- n2 = Node(2, 'B', 11.0, 21.0)
104
-
105
- # Build topology
106
- topo = Topology()
107
- topo.add_node(n1)
108
- topo.add_node(n2)
109
- # add links, compute metrics, visualize
110
- ```
111
-
112
-
113
- ## Development 🛠️
114
-
115
- See `CONTRIBUTING.md` for development guidelines, commit message rules and pre-commit setup.
116
-
117
-
118
-
119
- ## Class diagram
120
-
121
- ![](diagrams/class_diagram.puml)
122
-
123
- (If you prefer a rendered image of the UML, render the PlantUML file locally or in your CI pipeline.)
124
-
125
- ## License
126
-
127
- See `LICENSE` in the project root.
@@ -1,20 +0,0 @@
1
- analysis/__init__.py,sha256=qvUC9wV_jQNQIlwJXk7LJ-dkTXhH1Ttn0lKWIdwBbrc,52
2
- analysis/metrics.py,sha256=Di4HGHlz9c2UTCYdfnmjtPjo7w3wwYuyDPeXI7bR0zA,2592
3
- assets/DT14.json,sha256=eG7Yz7kIMSov3bWAlSBsA9dXpq7MZRN8IZF20OVg2Wc,7543
4
- assets/DT17.json,sha256=oC-5yxJpONqomYVMxLIeEf39UpPTAxUc3yDH9sVjot4,8505
5
- assets/FRANCE-43.json,sha256=NCb2NJnQv4dq7PAbjJQfdunE1JJRn3G2xFKEJzkHaMo,21918
6
- assets/JPN-12.json,sha256=IYGerYCjUsaYie2vSOpDwXR-hwT40fJJ4axeKAhCtBY,5377
7
- assets/NSFNet.json,sha256=_uiuG3_6RnjafsIZbg0-QoZFMtMmrSLIGQUTI5WaGzY,6888
8
- assets/PLN-12.json,sha256=zxmWnSONK6cR2SFB_cG92Mgts7lhXQWvx6V_KQkrXsI,5995
9
- assets/UKNet.json,sha256=TurrVnx6pa3IgpZYJziOUJlXIIPS5RalmMI5DgRX7dQ,11911
10
- elements/__init__.py,sha256=ZWSd5uwVtppJtMnZ30zrAdzXhUAYIK62RrUaH9rsWu0,180
11
- elements/link.py,sha256=BwjdCR8peh7dDpKunZodlIsjKcfvwjKxyQ3tmp1obb8,3778
12
- elements/node.py,sha256=zIzKm1_dlEqOuNQbNc-R3NOWHytk0Tn6jMLWIoV7ENk,2704
13
- topolib-0.3.0.dist-info/licenses/LICENSE,sha256=kbnIP0XU6f2ualiTjEawdlU81IGPBbwc-_GF3N-1e9E,1081
14
- topology/__init__.py,sha256=2VRhVm4ZvKBiTDB2T8BDmLZBpwGCVFRF3fvtxxC_d28,86
15
- topology/path.py,sha256=oUNwmpBcS6LMMAJIxokROm3MVqr7vRR44M3Fh5ADq_w,2057
16
- topology/topology.py,sha256=5aeIahfPEGAK01chEka21slkhg4D_hb7apMZpRn-VOg,4168
17
- topolib-0.3.0.dist-info/METADATA,sha256=T8UctAUpqw_jzfwbOkkAuyrxUj3PY8HesdFd6pfyGfw,4294
18
- topolib-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
19
- topolib-0.3.0.dist-info/top_level.txt,sha256=lyqPH1vGGLmvT7EaqN4in6QtMnjU1WVHMbD3AselI2o,34
20
- topolib-0.3.0.dist-info/RECORD,,
@@ -1,4 +0,0 @@
1
- analysis
2
- assets
3
- elements
4
- topology
File without changes
File without changes
File without changes
File without changes
File without changes