MTC improvements on applying project cards

.github/workflows/sphinx.yml

@@ -0,0 +1,155 @@
+
+# references: 
+# * understanding github actions: https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions
+# * example sphinx publishing action: https://github.com/coderefinery/sphinx-lesson/blob/master/.github/workflows/sphinx.yml
+
+name: sphinx
+on: [push]
+
+env:
+  DEFAULT_BRANCH: generic_agency
+  #SPHINXOPTS: "-W --keep-going -T"
+  # ^-- If these SPHINXOPTS are enabled, then be strict about the builds and fail on any warnings
+
+jobs:
+  build-and-deploy:
+    name: Build and gh-pages
+    runs-on: ubuntu-latest
+    steps:
+      # https://github.com/marketplace/actions/checkout
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+          lfs: true
+
+      # https://github.com/marketplace/actions/setup-python
+      # ^-- This gives info on matrix testing.
+      - name: Install Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      # https://docs.github.com/en/actions/guides/building-and-testing-python#caching-dependencies
+      # ^-- How to set up caching for pip on Ubuntu
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('dev-requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+            ${{ runner.os }}-
+
+      # https://docs.github.com/en/actions/guides/building-and-testing-python#installing-dependencies
+      # ^-- This gives info on installing dependencies with pip
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -r dev-requirements.txt
+      - name: Debugging information
+        run: |
+          echo "github.ref:" ${{github.ref}}
+          echo "github.event_name:" ${{github.event_name}}
+          echo "github.head_ref:" ${{github.head_ref}}
+          echo "github.base_ref:" ${{github.base_ref}}
+          set -x
+          git rev-parse --abbrev-ref HEAD
+          git branch
+          git branch -a
+          git remote -v
+          python -V
+          pip list --not-required
+          pip list
+
+      # Build
+      - uses: ammaraskar/sphinx-problem-matcher@master
+      - name: Build Sphinx docs
+        run: |
+          cd docs
+          make dirhtml
+          # This fixes broken copy button icons, as explained in
+          #   https://github.com/coderefinery/sphinx-lesson/issues/50
+          #   https://github.com/executablebooks/sphinx-copybutton/issues/110
+          # This can be removed once these PRs are accepted (but the
+          # fixes also need to propagate to other themes):
+          #   https://github.com/sphinx-doc/sphinx/pull/8524
+          #   https://github.com/readthedocs/sphinx_rtd_theme/pull/1025
+          sed -i 's/url_root="#"/url_root=""/' _build/dirhtml/index.html || true
+
+      # The following supports building all branches and combining on
+      # gh-pages
+
+      # Clone and set up the old gh-pages branch
+      - name: Clone old gh-pages
+        if: ${{ github.event_name == 'push' }}
+        run: |
+          set -x
+          git fetch
+          ( git branch gh-pages remotes/origin/gh-pages && git clone . --branch=gh-pages _gh-pages/ ) || mkdir _gh-pages
+          rm -rf _gh-pages/.git/
+          mkdir -p _gh-pages/branch/
+
+      # If a push and default branch, copy build to _gh-pages/ as the "main"
+      # deployment.
+      - name: Copy new build (default branch)
+        if: |
+          contains(github.event_name, 'push') &&
+          contains(github.ref, env.DEFAULT_BRANCH)
+        run: |
+          set -x
+          # Delete everything under _gh-pages/ that is from the
+          # primary branch deployment.  Excludes the other branches
+          # _gh-pages/branch-* paths, and not including
+          # _gh-pages itself.
+          find _gh-pages/ -mindepth 1 ! -path '_gh-pages/branch*' -delete
+          rsync -a docs/_build/dirhtml/ _gh-pages/
+
+      # If a push and not on default branch, then copy the build to
+      # _gh-pages/branch/$brname (transforming '/' into '--')
+      - name: Copy new build (branch)
+        if: |
+          contains(github.event_name, 'push') &&
+          !contains(github.ref, env.DEFAULT_BRANCH)
+        run: |
+          set -x
+          #brname=$(git rev-parse --abbrev-ref HEAD)
+          brname="${{github.ref}}"
+          echo "brname:" ${brname}}
+          brname="${brname##refs/heads/}"
+          echo "brname:" ${brname}}
+          brdir=${brname//\//--}   # replace '/' with '--'
+          echo "brdir:" ${brdir}}
+          rm -rf   _gh-pages/branch/${brdir}
+          rsync -a docs/_build/dirhtml/ _gh-pages/branch/${brdir}
+      # Go through each branch in _gh-pages/branch/, if it's not a
+      # ref, then delete it.
+      - name: Delete old feature branches
+        if: ${{ github.event_name == 'push' }}
+        run: |
+          set -x
+          for brdir in `ls _gh-pages/branch/` ; do
+              brname=${brdir//--/\/}   # replace '--' with '/'
+              if ! git show-ref remotes/origin/$brname ; then
+                  echo "Removing $brdir"
+                  rm -r _gh-pages/branch/$brdir/
+              fi
+          done
+
+      # Add the .nojekyll file
+      - name: nojekyll
+        if: ${{ github.event_name == 'push' }}
+        run: |
+          touch _gh-pages/.nojekyll
+
+      # Deploy
+      # https://github.com/peaceiris/actions-gh-pages
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' }}
+        #if: ${{ success() && github.event_name == 'push' && github.ref == 'refs/heads/$defaultBranch' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: _gh-pages/
+          force_orphan: true

.gitignore

@@ -13,6 +13,7 @@ scratch/*
 .cache
 tests/t_*
 tests/*.txt
+
 # Logs
 *.log
 scenario_log.txt
@@ -67,3 +68,4 @@ env/
 .pydevproject
 .settings
 *.hubstorinfo
+.vscode/

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "python.pythonPath": "/Users/elizabeth/anaconda3/bin/python"
+}

dev-requirements.txt

@@ -1,6 +1,7 @@
 pytest
 jupyter
 notebook
+pytest-notebook
 recommonmark
 sphinx
 sphinx-autodoc-typehints

docs/conf.py

@@ -28,8 +28,8 @@
 # -- Project information -----------------------------------------------------
 
 project = "Network Wrangler"
-copyright = "2020, Metropolitan Council"
-author = "Metropolitan Council"
+copyright = "2020-2022, Metropolitan Council, Metropolitan Transportation Commission"
+author = "Metropolitan Council, Metropolitan Transportation Commission"
 
 
 # -- General configuration ---------------------------------------------------

docs/index.rst

@@ -6,7 +6,7 @@
 Welcome to Network Wrangler's documentation!
 ============================================
 
-.. note::  This documentation is based on the master branch
+.. note::  This documentation is based on the `generic_agency <https://github.com/BayAreaMetro/network_wrangler/tree/generic_agency>`_ branch
 
 Objectives
 ------------

examples/mtc/agency.txt

@@ -0,0 +1,31 @@
+agency_id,agency_name,agency_url,agency_timezone,agency_lang,agency_raw_name,agency_phone,agency_fare_url,agency_email
+BART,Bay Area Rapid Transit,http://www.bart.gov,America/Los_Angeles,en,BART_2015_8_3,,,
+CE,ACE Altamont Corridor Express,http://www.acerail.com/,America/Los_Angeles,en,ACE_2017_3_20,8004117245,,
+,County Connection,http://www.countyconnection.com/,America/Los_Angeles,EN,CCTA_2015_8_11,925-676-7500,,
+caltrain-ca-us,Caltrain,http://www.caltrain.com,America/Los_Angeles,en,Caltrain_2015_5_13,800-660-4287,,
+573,Emery Go-Round,http://www.emerygoround.com/,America/Los_Angeles,en,Emeryville_2016_10_26,(510) 451-3862,,
+36,Fairfield and Suisun Transit,http://www.fasttransit.org/,America/Los_Angeles,en,Fairfield_2015_10_14,707-422-2877,http://www.fasttransit.org/fares-passes/,
+,Golden Gate Transit,http://www.goldengate.org,America/Vancouver,en,GGTransit_2015_9_3,(415) 455-2000),http://www.goldengatetransit.org/fareprograms/,
+533,MVgo Mountain View,http://www.mvgo.org,America/Los_Angeles,en,MVGo_2016_10_26,(650) 933-2518,http://mvgo.org/rider-info.html,
+,Stanford Marguerite Shuttle,http://marguerite.stanford.edu,America/Los_Angeles,en,Marguerite_2016_10_10,650-723-9362,,
+MCTD,Marin Transit,http://marintransit.org,America/Los_Angeles,en,MarinTransit_2015_8_31,415-226-0855,,
+5,Rio Vista Delta Breeze,http://www.riovistacity.com/transit/,America/Los_Angeles,en,RioVista_2015_8_20,(707) 374-2878,,
+SFMTA,San Francisco Municipal Transportation Agency,http://www.sfmta.com,America/Los_Angeles,en,SFMTA_2015_8_11,,,
+samtrans-ca-us,SamTrans,http://www.samtrans.com,America/Los_Angeles,en,SamTrans_2015_8_20,800-660-4287,,
+247,SolTrans,http://www.soltransride.com,America/Vancouver,en,Soltrans_2016_5_20,(707) 648-4666,http://www.soltransride.com/fares/fares,
+183,Cloverdale Transit,http://www.cloverdale.net/index.aspx?NID=267,America/Los_Angeles,en,SonomaCounty_2015_8_18,(707) 894-2521,,
+175,Sonoma County Transit,http://www.sctransit.com/?referrer=gtfs,America/Los_Angeles,en,SonomaCounty_2015_8_18,(707) 576-7433,http://sctransit.com/fares/?referrer=gtfs,
+VTA,VTA,http://www.vta.org,America/Los_Angeles,EN,VTA_2015_8_27,408-321-2300,,
+tri-delta-transit,Tri Delta Transit,http://trideltatransit.com,America/Los Angeles,en,TriDelta-GTFS-2018-05-24_21-43-17,(925) 754-4040,http://trideltatransit.com/fares.aspx,
+UCT,Union City Transit,http://www.uctransit.org,America/Los_Angeles,EN,Union_City_Transit_Aug-01-2015 to Jun-30-2017,510-471-1411,http://www.unioncity.org/departments/transit/fares/fares-information,transit@unioncity.org
+362,Vine (Napa County),http://www.ridethevine.com/vine,America/Los_Angeles,EN,Vine_GTFS_PLUS_2015,,,
+267,Petaluma Transit,http://cityofpetaluma.net/pubworks/transit-sub.html,America/Los_Angeles,en,petalumatransit-petaluma-ca-us__11_12_15,(707)778-4303,http://cityofpetaluma.net/pubworks/fares-transfers.html,
+869,Vacaville City Coach,http://www.citycoach.com/,America/Los_Angeles,en,vacavillecitycoach-2020-ca-us,707-449-6000,http://www.citycoach.com/fares/,
+392,WestCat (Western Contra Costa),http://www.westcat.org/index.html,America/Los_Angeles,en,westcat-ca-us_9_17_2015,510-724-7993,http://www.westcat.org/fares/index.html,
+SB,San Francisco Bay Ferry,http://www.sanfranciscobayferry.com,America/Los_Angeles,en,SF_Bay_Ferry2016_07_01,4157058291,,
+AC Transit,AC Transit,http://www.actransit.org,America/Los_Angeles,,ACTransit_2015_8_14,(510) 891-4777,,
+BG,Blue & Gold Fleet,http://www.blueandgoldfleet.com/,America/Los_Angeles,en,Blue&Gold_gtfs_10_4_2017,4157058200,,
+AM,Capitol Corridor,http://www.capitolcorridor.org,America/Los_Angeles,en,Capitol_2017_3_20,8779743322,,
+SRCityBus,Santa Rosa CityBus,http://ci.santa-rosa.ca.us/departments/transit/CityBus/Pages/default.aspx,America/Los_Angeles,en,SantaRosa_google_transit_08_28_15,707-543-3333,http://ci.santa-rosa.ca.us/departments/transit/citybus/Pages/Fares.aspx,
+LAVTA,Wheels Bus,http://wheelsbus.com/,America/Los_Angeles,en,Wheels_2016_7_13,(925) 455-7500,http://wheelsbus.com/index.aspx?page=198,
+alliance,Commute.org Shuttle,http://www.commute.org,America/Los_Angeles,en,(650) 588-8170,commuteDOTorg_GTFSImportExport_20160127_final_mj,,