Github actions and tests

.github/workflows/linkcheck.yml

@@ -0,0 +1,21 @@
+name: Link Check
+on: [push, pull_request]
+
+jobs:
+  linkcheck:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+        architecture: x64
+    - uses: actions/cache@v1
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+    - run: pip install -r requirements.txt
+    - run: cd ./docs/ && make dirhtml
+    - run: cd ./docs/ && make linkcheck

.github/workflows/mdformat.yml

@@ -0,0 +1,20 @@
+name: MD Format
+on: [push, pull_request]
+
+jobs:
+  mdformat:
+    name: Mdformat Action
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+        architecture: x64
+    - uses: actions/cache@v1
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+    - run: pip install -r requirements.txt
+    - run: mdformat --check ./docs/**/*.md

.github/workflows/run-tests.yml

@@ -0,0 +1,19 @@
+name: Run all tests
+on: [push, pull_request]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+        architecture: x64
+    - uses: actions/cache@v1
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+    - run: pip install -r requirements.txt
+    - run: pytest tests

.github/workflows/sphinx-build.yml

@@ -0,0 +1,19 @@
+name: Sphinx Build
+on: [push, pull_request]
+
+jobs:
+  linkcheck:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+        architecture: x64
+    - uses: actions/cache@v1
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+    - run: pip install -r requirements.txt
+    - run: cd ./docs/ && sphinx-build -nW . ./temp_build

.gitignore

@@ -1,4 +1,6 @@
 .ve
 *.swp
 *~
-_build
+_build
+.pyest*
+__pycache__

codelists/closed/deployment.csv

@@ -1,3 +1,3 @@
-code,title,description
-aboveGround,Above ground,"This span is deployed above ground. For example, aerial deployment along poles or using optical groundwire."
-belowGround,Below ground,"This span is deployed below ground. For example, cable that is routed through a duct buried in a trench or run through a sewer."
+Code,Title,Description
+aboveGround,Above ground,"This span is deployed above ground. For example, aerial deployment along poles or using optical groundwire."
+belowGround,Below ground,"This span is deployed below ground. For example, cable that is routed through a duct buried in a trench or run through a sewer."

codelists/closed/fibreType.csv

@@ -1,8 +1,8 @@
-code,title,description
-G.651.1,G.651.1,A 50/125 µm multimode graded index optical fibre cable for the optical access network that conforms to ITU-T recommendation G.651.1.
-G.652,G.652,A single-mode optical fibre and cable that conforms to ITU-T recommendation G.652.
-G.653,G.653,"A dispersion-shifted, single-mode optical fibre and cable that conforms to ITU-T recommendation G.653."
-G.654,G.654,A cut-off shifted single-mode optical fibre and cable that conforms to ITU-T recommendation G.654.
-G.655,G.655,A non-zero dispersion-shifted single-mode optical fibre and cable that conforms to ITU-T recommendation G.655.
-G.656,G.656,A fibre and cable with non-zero dispersion for wideband optical transport that conforms to ITU-T recommendation G.656.
-G.657,G.657,A bending-loss insensitive single-mode optical fibre and cable that conforms to ITU-T recommendation G.657.
+Code,Title,Description
+G.651.1,G.651.1,A 50/125 µm multimode graded index optical fibre cable for the optical access network that conforms to ITU-T recommendation G.651.1.
+G.652,G.652,A single-mode optical fibre and cable that conforms to ITU-T recommendation G.652.
+G.653,G.653,"A dispersion-shifted, single-mode optical fibre and cable that conforms to ITU-T recommendation G.653."
+G.654,G.654,A cut-off shifted single-mode optical fibre and cable that conforms to ITU-T recommendation G.654.
+G.655,G.655,A non-zero dispersion-shifted single-mode optical fibre and cable that conforms to ITU-T recommendation G.655.
+G.656,G.656,A fibre and cable with non-zero dispersion for wideband optical transport that conforms to ITU-T recommendation G.656.
+G.657,G.657,A bending-loss insensitive single-mode optical fibre and cable that conforms to ITU-T recommendation G.657.

codelists/closed/geometryType.csv

@@ -1,3 +1,3 @@
-code,title,description
-LineString,Line string,"A GeoJSON LineString, i.e. an array of two or more positions."
-Point,Point,"A GeoJSON Point, i.e. a single position."
+Code,Title,Description
+LineString,Line string,"A GeoJSON LineString, i.e. an array of two or more positions."
+Point,Point,"A GeoJSON Point, i.e. a single position."

codelists/closed/nodeStatus.csv

@@ -1,7 +1,7 @@
-code,title,description
-proposed,Proposed,Planning for the node is at an early stage and financing for its construction is not yet finalised.
-planned,Planned,Planning for the node is at an advanced stage and financing for its construction is finalised.
-underConstruction,Under construction,Construction of the passive physical infrastructure for the node is in progress.
-operational,Operational,The active network infrastructure for the node is live and carrying traffic.
-decommissioned,Decommissioned,The node is no longer operational.
-inactive,Inactive,"Construction of the passive network infrastructure is complete, but the node is not yet operational."
+Code,Title,Description
+proposed,Proposed,Planning for the node is at an early stage and financing for its construction is not yet finalised.
+planned,Planned,Planning for the node is at an advanced stage and financing for its construction is finalised.
+underConstruction,Under construction,Construction of the passive physical infrastructure for the node is in progress.
+operational,Operational,The active network infrastructure for the node is live and carrying traffic.
+decommissioned,Decommissioned,The node is no longer operational.
+inactive,Inactive,"Construction of the passive network infrastructure is complete, but the node is not yet operational."

codelists/closed/spanStatus.csv

@@ -1,7 +1,7 @@
-code,title,description
-operational,Operational,The active network infrastructure for the span is live and carrying traffic.
-underConstruction,Under construction,Construction of the passive physical infrastructure for the span is in progress.
-planned,Planned,Planning for the span is at an advanced stage and financing for its construction is finalised.
-decommissioned,Decommissioned,The span is no longer operational.
-proposed,Proposed,Planning for the span is at an early stage and financing for its construction is not yet finalised.
-inactive,Inactive,"Construction of the passive network infrastructure is complete, but the span is not yet operational."
+Code,Title,Description
+operational,Operational,The active network infrastructure for the span is live and carrying traffic.
+underConstruction,Under construction,Construction of the passive physical infrastructure for the span is in progress.
+planned,Planned,Planning for the span is at an advanced stage and financing for its construction is finalised.
+decommissioned,Decommissioned,The span is no longer operational.
+proposed,Proposed,Planning for the span is at an early stage and financing for its construction is not yet finalised.
+inactive,Inactive,"Construction of the passive network infrastructure is complete, but the span is not yet operational."

codelists/closed/transmissionMedium.csv

@@ -1,5 +1,5 @@
-code,title,description
-fibre,Fibre optic cable,The physical media of this span is fibre optic cable.
-microwave,Microwave radio,The physical media of this span is microwave radio.
-copper,Copper wire,The physical media of this span is copper wire.
-coaxial,Coaxial cable,The physical media of this span is coaxial cable.
+Code,Title,Description
+fibre,Fibre optic cable,The physical media of this span is fibre optic cable.
+microwave,Microwave radio,The physical media of this span is microwave radio.
+copper,Copper wire,The physical media of this span is copper wire.
+coaxial,Coaxial cable,The physical media of this span is coaxial cable.

codelists/open/contractType.csv

@@ -1,4 +1,4 @@
-code,title,description
-ppp,Public Private Partnership (PPP),"A long-term contract between a private party and a government entity, for providing a public asset or service, in which the private party bears significant risk and management responsibility and remuneration is linked to performance. "
-private,Private,A contract in which the private sector takes ownership of the network and responsibility for its operation.
-public,Public,A contract in which the public sector owns the network and is responsible for its operation.
+Code,Title,Description
+ppp,Public Private Partnership (PPP),"A long-term contract between a private party and a government entity,for providing a public asset or service,in which the private party bears significant risk and management responsibility and remuneration is linked to performance."
+private,Private,A contract in which the private sector takes ownership of the network and responsibility for its operation.
+public,Public,A contract in which the public sector owns the network and is responsible for its operation.

codelists/open/linkRelationType.csv

@@ -1,6 +1,6 @@
-code,title,description
-describedby,Described by,Refers to the canonical JSON schema that describes the structure of the data.
-"tag:opentelecomdata.net,2022:nodesAPI",Nodes API,An API endpoint that returns a paginated list of `Node` objects.
-"tag:opentelecomdata.net,2022:nodesFile",Nodes file,A JSON Lines file containing one `Node` object per line. The file may be compressed using ZIP or GZIP.
-"tag:opentelecomdata.net,2022:spansAPI",Spans API,An API endpoint that returns a paginated list of `Span` objects.
-"tag:opentelecomdata.net,2022:spansFile",Spans file,A JSON Lines file containing one `Span` object per line. The file may be compressed using ZIP or GZIP.
+Code,Title,Description
+describedby,Described by,Refers to the canonical JSON schema that describes the structure of the data.
+"tag:opentelecomdata.net,2022:nodesAPI",Nodes API,An API endpoint that returns a paginated list of `Node` objects.
+"tag:opentelecomdata.net,2022:nodesFile",Nodes file,A JSON Lines file containing one `Node` object per line. The file may be compressed using ZIP or GZIP.
+"tag:opentelecomdata.net,2022:spansAPI",Spans API,An API endpoint that returns a paginated list of `Span` objects.
+"tag:opentelecomdata.net,2022:spansFile",Spans file,A JSON Lines file containing one `Span` object per line. The file may be compressed using ZIP or GZIP.

codelists/open/mediaType.csv

@@ -1903,4 +1903,4 @@ video/vnd.youtube.yt,vnd.youtube.yt
 video/vnd.vivo,vnd.vivo
 video/VP8,VP8
 video/VP9,VP9
-offline/print,print
+offline/print,print

codelists/open/nodeTechnologies.csv

@@ -1,3 +1,3 @@
-code,title,description
-mpls,Multi-Protocol Label Switching,A routing technique that directs data from one node to the next based on labels rather than network addresses.
-ip,Internet Protocol,A network layer protocol that defines the addressing mechanism on the Internet to allow data to be transmitted.
+Code,Title,Description
+mpls,Multi-Protocol Label Switching,A routing technique that directs data from one node to the next based on labels rather than network addresses.
+ip,Internet Protocol,A network layer protocol that defines the addressing mechanism on the Internet to allow data to be transmitted.

codelists/open/nodeType.csv

@@ -1,13 +1,13 @@
-code,title,description
-dataCentre,Data centre,"A structure, or group of structures, dedicated to the centralized accommodation, interconnection and operation of information technology and network telecommunications equipment."
-cableLanding,Cable landing point,The location where a submarine or other underwater cable makes landfall.
-pop,Point of Presence,"A demarcation point, access point, or physical location at which two or more networks or communication devices share a connection."
-tower,Tower,A ground-based or rooftop structure that supports antennas for sending or receiving radio waves. 
-ixp,Internet Exchange Point,"A physical point at which networks such as internet service providers, mobile operators and content delivery networks come together to connect and exchange internet traffic."
-borderCrossing,Border crossing,The point at which a fibre cable crosses either an international boundary or the coastline of the operator’s country. The countries to which this node connects should be listed in `.internationalConnections`.
-cabinet,Cabinet,An distribution cabinet to which end users are connected by a standard phone line.
-aggregationPoint,Aggregation point,A point at which multiple fibre optic cables are spliced together. Typically located between an exchange or POP and GPON splitters or end user premises.
-exchange,Exchange,A telephone exchange.
-substation,Substation,An electrical substation.
-addDropSite,Add drop site,"A point at which individual digital bit streams can be added to, or dropped from, a multiplexed signal in order to redirect bit streams between network paths. "
-repeaterSite,Repeater site,A point at which fibre optic signals are amplified or repeated. Also known as a regeneration facility.
+Code,Title,Description
+dataCentre,Data centre,"A structure, or group of structures, dedicated to the centralized accommodation, interconnection and operation of information technology and network telecommunications equipment."
+cableLanding,Cable landing point,The location where a submarine or other underwater cable makes landfall.
+pop,Point of Presence,"A demarcation point, access point, or physical location at which two or more networks or communication devices share a connection."
+tower,Tower,A ground-based or rooftop structure that supports antennas for sending or receiving radio waves.
+ixp,Internet Exchange Point,"A physical point at which networks such as internet service providers, mobile operators and content delivery networks come together to connect and exchange internet traffic."
+borderCrossing,Border crossing,The point at which a fibre cable crosses either an international boundary or the coastline of the operator’s country. The countries to which this node connects should be listed in `.internationalConnections`.
+cabinet,Cabinet,An distribution cabinet to which end users are connected by a standard phone line.
+aggregationPoint,Aggregation point,A point at which multiple fibre optic cables are spliced together. Typically located between an exchange or POP and GPON splitters or end user premises.
+exchange,Exchange,A telephone exchange.
+substation,Substation,An electrical substation.
+addDropSite,Add drop site,"A point at which individual digital bit streams can be added to, or dropped from, a multiplexed signal in order to redirect bit streams between network paths."
+repeaterSite,Repeater site,A point at which fibre optic signals are amplified or repeated. Also known as a regeneration facility.