Merge pull request #23 from wsp-sag/projectcard_api

Update to official `projectcard` api

Author: DavidOry

.github/workflows/run-tests.yml

@@ -9,15 +9,20 @@ jobs:
     steps:
 
       - name: checkout repo content
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: setup python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
-          python-version: '3.7'
-
-      - name: execute py script
+          python-version: '3.10'
+      
+      - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install --user -e git+https://github.com/wsp-sag/network_wrangler.git@master#egg=network_wrangler
+          pip install pytest
+          pip install -e git+https://github.com/network-wrangler/network_wrangler.git@main#egg=network_wrangler
+
+
+      - name: Run tests
+        run: |
           pytest -s -m ci

.github/workflows/update-registry.yml

@@ -9,28 +9,28 @@ jobs:
     steps:
 
       - name: checkout repo content
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: setup python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
-          python-version: '3.7'
+          python-version: '3.10'
 
       - name: execute py script
         run: |
           python -m pip install --upgrade pip
-          pip install --user -e git+https://github.com/wsp-sag/network_wrangler.git@master#egg=network_wrangler
+          pip install -e git+https://github.com/network-wrangler/network_wrangler.git@main#egg=network_wrangler
           python update_registry.py
 
       - name: commit files
         run: |
-          git config --local user.email "david.ory@gmail.com"
-          git config --local user.name "DavidOry"
+          git config --local user.email "github-actions[bot]"
+          git config --local user.name "github-actions[bot]@users.noreply.github.com"
           git add -A
           git commit --allow-empty -m "GitHub Action automated registry update" -a
 
       - name: push changes
         uses: ad-m/github-push-action@v0.6.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          branch: main
+          branch: ${{ github.ref_name }}

example/original_projects/project_A.yml

@@ -1,35 +1,32 @@
 project: Project A
-valid: false
 tags:
-   - 'registry example'
-dependencies:
-  prerequisites: []
-  corequisites: []
-  conflicts: []
-category: New Roadway
-links:
-  - A: 1001
-    B: 1002
-    model_link_id: 501
-    distance : 0.15
-    name: 'Main Street'
-    lanes: 2
-    bike_access: 1
-    drive_access: 1
-    transit_access: 0
-    walk_access: 1
-nodes:
-  - X: -93.14412
-    Y: 44.87497
-    bike_node: 0
-    drive_node: 1
-    transit_node: 0
-    walk_node: 0
-    model_node_id: 1001
-  - X: -93.14189
-    Y: 44.87499
-    bike_node: 0
-    drive_node: 1
-    transit_node: 0
-    walk_node: 0
-    model_node_id: 1002
+- registry_example
+dependencies: {}
+changes:
+- roadway_addition:
+    links:
+    - A: 1001
+      B: 1002
+      model_link_id: 501
+      distance: 0.25
+      name: Main Street
+      lanes: 2
+      bike_access: 1
+      drive_access: 1
+      transit_access: 0
+      walk_access: 1
+    nodes:
+    - X: -93.1111
+      Y: 44.8888
+      bike_node: 0
+      drive_node: 1
+      transit_node: 0
+      walk_node: 0
+      model_node_id: 1001
+    - X: -93.4444
+      Y: 44.5555
+      bike_node: 0
+      drive_node: 1
+      transit_node: 0
+      walk_node: 0
+      model_node_id: 1002

example/original_projects/project_B.yml

@@ -1,35 +1,36 @@
 project: Project B
-valid: false
 tags:
-   - 'registry example'
-dependencies:
-  prerequisites: []
-  corequisites: []
-  conflicts: []
-category: New Roadway
-links:
-  - A: 1001
-    B: 1002
-    model_link_id: 501
-    distance : 0.2500
-    name: 'Broad Street'
-    lanes: 2
-    bike_access: 1
-    drive_access: 1
-    transit_access: 0
-    walk_access: 1
-nodes:
-  - X: -93.14322
-    Y: 44.87414
-    bike_node: 0
-    drive_node: 1
-    transit_node: 0
-    walk_node: 0
-    model_node_id: 1001
-  - X: -93.14273
-    Y: 44.87648
-    bike_node: 0
-    drive_node: 1
-    transit_node: 0
-    walk_node: 0
-    model_node_id: 1002
+- registry_example
+dependencies: {}
+changes:
+- roadway_deletion:
+    links:
+      model_link_id:
+      - 123
+- roadway_addition:
+    links:
+    - A: 1003
+      B: 1004
+      model_link_id: 502
+      distance: 0.25
+      name: Broad Street
+      lanes: 2
+      bike_access: 1
+      drive_access: 1
+      transit_access: 0
+      walk_access: 1
+    nodes:
+    - X: -93.2222
+      Y: 44.1111
+      bike_node: 0
+      drive_node: 1
+      transit_node: 0
+      walk_node: 0
+      model_node_id: 1003
+    - X: -93.3333
+      Y: 44.2222
+      bike_node: 0
+      drive_node: 1
+      transit_node: 0
+      walk_node: 0
+      model_node_id: 1004

methods_add_cards.py

@@ -2,7 +2,11 @@
 from numpy import True_
 import pandas as pd
 from typing import Tuple
-from network_wrangler import ProjectCard
+
+from pathlib import Path
+
+from projectcard import ProjectCard
+from projectcard import write_card
 
 
 def add_cards_to_registry(
@@ -30,8 +34,8 @@ def add_cards_to_registry(
     for card, filename in card_file_list:
         if card.project not in input_df["project_added"].values:
             for change_index, change_dict in enumerate(card.changes):
-                if change_dict.get("category", "Missing") == "Add New Roadway":
-                    if "nodes" in change_dict:
+                if "roadway_addition" in change_dict:
+                    if "nodes" in change_dict["roadway_addition"]:
                         node_df, node_update, card = _update_registry(
                             "nodes",
                             out_df,
@@ -52,10 +56,10 @@ def add_cards_to_registry(
                     )
 
                     if node_df is not None:
-                        out_df = out_df.append(node_df, ignore_index=True)
+                        out_df = pd.concat([out_df, node_df], ignore_index=True)
 
                     out_df = (
-                        out_df.append(link_df, ignore_index=True)
+                        pd.concat([out_df, link_df], ignore_index=True)
                         .drop_duplicates()
                         .reset_index(drop=True)
                     )
@@ -66,7 +70,7 @@ def add_cards_to_registry(
                                 card.__dict__.pop("file")
                             if "valid" in card.__dict__:
                                 card.__dict__.pop("valid")
-                            card.write(filename=filename)
+                            write_card(card, filename=Path(filename))
 
     return out_df
 
@@ -238,7 +242,7 @@ def _update_registry(
 
     subject_df = input_df[input_df["type"] == subject_word]
 
-    for subject_index, subject in enumerate(card.changes[change_index][nodes_or_links]):
+    for subject_index, subject in enumerate(card.changes[change_index]["roadway_addition"][nodes_or_links]):
         new_id = subject[subject_id_word]
 
         _is_id_in_allowable_range(subject_word, card.project, new_id, range_in_use)
@@ -251,7 +255,7 @@ def _update_registry(
                     "project_added": [card.project],
                 }
             )
-            subject_df = subject_df.append(updates_df)
+            subject_df = pd.concat([subject_df, updates_df])
         else:
             number = _find_available_id(
                 subject_word,
@@ -260,23 +264,23 @@ def _update_registry(
                 range_in_use,
                 subject_df,
             )
-            card.changes[change_index][nodes_or_links][subject_index][
+            card.changes[change_index]["roadway_addition"][nodes_or_links][subject_index][
                 subject_id_word
             ] = number
             if nodes_or_links == "nodes":
-                for i in range(0, len(card.changes[change_index]["links"])):
-                    if card.changes[change_index]["links"][i]["A"] == new_id:
-                        card.changes[change_index]["links"][i]["A"] = number
-                    if card.changes[change_index]["links"][i]["B"] == new_id:
-                        card.changes[change_index]["links"][i]["B"] = number
+                for i in range(0, len(card.changes[change_index]["roadway_addition"]["links"])):
+                    if card.changes[change_index]["roadway_addition"]["links"][i]["A"] == new_id:
+                        card.changes[change_index]["roadway_addition"]["links"][i]["A"] = number
+                    if card.changes[change_index]["roadway_addition"]["links"][i]["B"] == new_id:
+                        card.changes[change_index]["roadway_addition"]["links"][i]["B"] = number
             updates_df = pd.DataFrame(
                 {
                     "type": subject_word,
                     "id": [number],
                     "project_added": [card.project],
                 }
             )
-            subject_df = subject_df.append(updates_df)
+            subject_df = pd.concat([subject_df, updates_df])
             write_updated_card = True
 
     return subject_df, write_updated_card, card

methods_io.py

@@ -1,5 +1,5 @@
 import os
-from network_wrangler import ProjectCard
+from projectcard import read_card
 
 CARD_DIR = os.path.join(".", "projects")
 
@@ -22,7 +22,7 @@ def read_project_cards(card_dir: str = CARD_DIR) -> list:
             name, extension = os.path.splitext(filename)
             if extension in [".yml", ".yaml"]:
                 card_file = os.path.join(dirpath, filename)
-                card = ProjectCard.read(card_file, validate=False)
+                card = read_card(card_file, validate=True)
                 card_file_list.append((card, card_file))
 
     return card_file_list

projects/project_A.yml

@@ -1,32 +1,32 @@
 project: Project A
 tags:
 - registry_example
-dependencies: ''
+dependencies: {}
 changes:
-- category: Add New Roadway
-  links:
-  - A: 1001
-    B: 1002
-    model_link_id: 501
-    distance: 0.25
-    name: Main Street
-    lanes: 2
-    bike_access: 1
-    drive_access: 1
-    transit_access: 0
-    walk_access: 1
-  nodes:
-  - X: -93.1111
-    Y: 44.8888
-    bike_node: 0
-    drive_node: 1
-    transit_node: 0
-    walk_node: 0
-    model_node_id: 1001
-  - X: -93.4444
-    Y: 44.5555
-    bike_node: 0
-    drive_node: 1
-    transit_node: 0
-    walk_node: 0
-    model_node_id: 1002
+- roadway_addition:
+    links:
+    - A: 1001
+      B: 1002
+      model_link_id: 501
+      distance: 0.25
+      name: Main Street
+      lanes: 2
+      bike_access: 1
+      drive_access: 1
+      transit_access: 0
+      walk_access: 1
+    nodes:
+    - X: -93.1111
+      Y: 44.8888
+      bike_node: 0
+      drive_node: 1
+      transit_node: 0
+      walk_node: 0
+      model_node_id: 1001
+    - X: -93.4444
+      Y: 44.5555
+      bike_node: 0
+      drive_node: 1
+      transit_node: 0
+      walk_node: 0
+      model_node_id: 1002