From 927bc8857dac77d5746a9d39cd8d75be3f14402d Mon Sep 17 00:00:00 2001 From: Pavel 'LEdoian' Turinsky Date: Tue, 22 Nov 2022 16:25:07 +0100 Subject: [PATCH 1/3] Initial version of packaging This is only support "code", the real code has not been migrated yet. Also, the README is quite lacking in content. --- README.md | 4 ++++ birdvisu/__init__.py | 2 ++ pyproject.toml | 22 ++++++++++++++++++++++ 3 files changed, 28 insertions(+) create mode 100644 README.md create mode 100644 pyproject.toml diff --git a/README.md b/README.md new file mode 100644 index 0000000..fc37ebf --- /dev/null +++ b/README.md @@ -0,0 +1,4 @@ +A simple tool for visualising OSPF network topology as seen by BIRD +==== + + diff --git a/birdvisu/__init__.py b/birdvisu/__init__.py index 373ef8f..f7e029b 100644 --- a/birdvisu/__init__.py +++ b/birdvisu/__init__.py @@ -1,3 +1,5 @@ from pathlib import Path assets = Path(__file__).resolve().parent / 'assets' + +__version__ = '0.0.1-a1.dev1' diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..12b8607 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,22 @@ +[project] +name = 'birdvisu' +description = 'A simple tool for visualising OSPF network topology as seen by BIRD' +dynamic = ['version'] +readme = './README.md' +requires-python = '~= 3.10' +dependencies = [ + 'PySide6', +] + +[build-system] +requires = ["flit_core >=3.2,<4"] +build-backend = "flit_core.buildapi" + +[project.optional-dependencies] +# Just a PoC as of now, but we will (hopefully) use these tools in the future. +doc = [ + 'sphinx', + ] +check = [ + 'mypy' + ] From 52050338d65a9767c6a21d474b591b0a692a8f79 Mon Sep 17 00:00:00 2001 From: Pavel 'LEdoian' Turinsky Date: Tue, 22 Nov 2022 19:45:39 +0100 Subject: [PATCH 2/3] More text in README --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fc37ebf..698bad2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,13 @@ A simple tool for visualising OSPF network topology as seen by BIRD ==== - +This is a tool to visualize current state of the OSPF network and compare it to +a reference / expected state. + + +## Installation + +Run `pip install -e .`. You can use a virtualenv if you wish (recommended). + +A demo is located in `./poor_mans_visualisation.py`, if that runs, everything +should be working. From ef39d1a9a5fb00026b3c126c2ef08f0b01de0784 Mon Sep 17 00:00:00 2001 From: Pavel 'LEdoian' Turinsky Date: Fri, 16 Jun 2023 12:59:16 +0200 Subject: [PATCH 3/3] Drop the symlink in snippets Since the project can now be installed with pip editable install, it is now in sys.path and therefore installable out-of-box --- snippets/birdvisu | 1 - 1 file changed, 1 deletion(-) delete mode 120000 snippets/birdvisu diff --git a/snippets/birdvisu b/snippets/birdvisu deleted file mode 120000 index 90a1f0e..0000000 --- a/snippets/birdvisu +++ /dev/null @@ -1 +0,0 @@ -../birdvisu \ No newline at end of file