Setup GitHub actions (#12)

* Update pyproject.toml * Add dependabot * Add GitHub Actions
worldbank · Feb 26, 2024 · d386549 · d386549
1 parent 8171bcc
commit d386549
Show file tree

Hide file tree

Showing 47 changed files with 173 additions and 6 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "monthly"
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -0,0 +1,29 @@
+name: docs
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: "pip"
+      - name: Dependencies
+        run: |
+          if [ -f pyproject.toml ]; then pip install ".[docs]"; fi
+      - name: Build Sphinx Documentation
+        run: |
+          sphinx-build docs _build/html -b html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: job.status == 'success'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./_build/html
+          enable_jekyll: false
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -0,0 +1,52 @@
+name: Publish Python 🐍 distribution 📦 to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel and a source tarball
+        run: python3 -m build
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/blackmarblepy
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/README.md b/README.md
@@ -1,14 +1,12 @@
 # Quantifying urbanization
 
-![Accra urbanization](images/ACCRA_GHSSMOD_Python_250m.png)
+Urbanization is a foundational aspect of understanding the human condition, and has been a focus of economic, social, and development study for many years. This code repository is meant to centralize many of the urban analytics performed by the [World Bank's Global Operational Support Team (GOST)](https://worldbank.github.io/GOST) in support of World Bank Group operations. There are numerous code examples in the [notebooks](https://github.com/worldbank/GOST_Urban/tree/main/notebooks) folder including both tutorials and records of project implementations.
 
-Urbanization is a foundational aspect of understanding the human condition, and has been a focus of economic, social, and development study for many years. This code repository is meant to centralize many of the urban analytics performed by the World Bank's Global Operational Support Team (GOST) in support of World Bank Group operations. There are numerous code examples in the [notebooks](https://github.com/worldbank/GOST_Urban/tree/main/notebooks) folder including both tutorials and records of project implementations.
-
-This repo includes a [Documentation](https://worldbank.github.io/GOST_Urban/intro.html) and a [Wiki](https://github.com/worldbank/GOST_Urban/wiki) for the documentation.
+This repo includes a [GitHub Pages](https://worldbank.github.io/GOST_Urban/intro.html) and a [Wiki](https://github.com/worldbank/GOST_Urban/wiki) for the documentation.
 
 ## Installation
 
-**GOSTurbna** is available on [PyPI](https://pypi.org) and can installed using `pip`:
+**GOSTurban** is available on [PyPI](https://pypi.org) and can installed using `pip`:
 
 ### From PyPI
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,78 @@
+###############################################################################
+# Auto-generated by `jupyter-book config`
+# If you wish to continue using _config.yml, make edits to that file and
+# re-generate this one.
+###############################################################################
+apidoc_module_dir = "../src"
+author = "Benjamin P. Stewart"
+bibtex_bibfiles = ["references.bib"]
+comments_config = {"hypothesis": False, "utterances": False}
+copyright = "2024"
+exclude_patterns = ["**.ipynb_checkpoints", ".DS_Store", "Thumbs.db", "_build"]
+extensions = [
+    "sphinx_togglebutton",
+    "sphinx_copybutton",
+    "myst_nb",
+    "jupyter_book",
+    "sphinx_thebe",
+    "sphinx_comments",
+    "sphinx_external_toc",
+    "sphinx.ext.intersphinx",
+    "sphinx_design",
+    "sphinx_book_theme",
+    "sphinxcontrib.bibtex",
+    "sphinx_jupyterbook_latex",
+    "sphinx.ext.napoleon",
+    "sphinxcontrib.apidoc",
+]
+external_toc_exclude_missing = True
+external_toc_path = "_toc.yml"
+extra_extensions = ["sphinxcontrib.apidoc"]
+html_baseurl = "https://worldbank.github.io/GOSTurban"
+html_favicon = "images/favicon.ico"
+html_last_updated_fmt = "%b %d, %Y"
+html_logo = "images/logo.png"
+html_show_copyright = False
+html_sourcelink_suffix = ""
+html_theme = "sphinx_book_theme"
+html_theme_options = {
+    "search_bar_text": "Search this book...",
+    "launch_buttons": {
+        "notebook_interface": "classic",
+        "binderhub_url": "",
+        "jupyterhub_url": "",
+        "thebe": False,
+        "colab_url": "",
+    },
+    "path_to_docs": "",
+    "repository_url": "https://github.com/worldbank/GOSTurban",
+    "repository_branch": "main",
+    "extra_footer": "",
+    "home_page_in_toc": True,
+    "announcement": "",
+    "use_repository_button": True,
+    "use_edit_page_button": True,
+    "use_issues_button": True,
+}
+html_title = ""
+latex_engine = "pdflatex"
+myst_enable_extensions = [
+    "colon_fence",
+    "dollarmath",
+    "linkify",
+    "substitution",
+    "tasklist",
+]
+myst_url_schemes = ["mailto", "http", "https"]
+nb_execution_allow_errors = False
+nb_execution_cache_path = ""
+nb_execution_excludepatterns = []
+nb_execution_in_temp = False
+nb_execution_mode = "off"
+nb_execution_timeout = 30
+nb_output_stderr = "show"
+numfig = True
+pygments_style = "sphinx"
+suppress_warnings = ["myst.domains"]
+use_jupyterbook_latex = True
+use_multitoc_numbering = True
diff --git a/...s/JUP_SURGP_GLO_B_D__LEI_Evaluation.ipynb → ...s/JUP_SURGP_GLO_B_D__LEI_Evaluation.ipynb b/...s/JUP_SURGP_GLO_B_D__LEI_Evaluation.ipynb → ...s/JUP_SURGP_GLO_B_D__LEI_Evaluation.ipynb
diff --git a/...rbanizationReview/ECA_Urban_Extents.ipynb → ...rbanizationReview/ECA_Urban_Extents.ipynb b/...rbanizationReview/ECA_Urban_Extents.ipynb → ...rbanizationReview/ECA_Urban_Extents.ipynb
diff --git a/...ationReview/KAZ_Urbanization_Review.ipynb → ...ationReview/KAZ_Urbanization_Review.ipynb b/...ationReview/KAZ_Urbanization_Review.ipynb → ...ationReview/KAZ_Urbanization_Review.ipynb
diff --git a/...ionReview/Urban_metrics_Combine_All.ipynb → ...ionReview/Urban_metrics_Combine_All.ipynb b/...ionReview/Urban_metrics_Combine_All.ipynb → ...ionReview/Urban_metrics_Combine_All.ipynb
diff --git a/...zationReview/Urban_metrics_Fullness.ipynb → ...zationReview/Urban_metrics_Fullness.ipynb b/...zationReview/Urban_metrics_Fullness.ipynb → ...zationReview/Urban_metrics_Fullness.ipynb
diff --git a/...anizationReview/Urban_metrics_Shape.ipynb → ...anizationReview/Urban_metrics_Shape.ipynb b/...anizationReview/Urban_metrics_Shape.ipynb → ...anizationReview/Urban_metrics_Shape.ipynb
diff --git a/...nizationReview/Urban_metrics_Sprawl.ipynb → ...nizationReview/Urban_metrics_Sprawl.ipynb b/...nizationReview/Urban_metrics_Sprawl.ipynb → ...nizationReview/Urban_metrics_Sprawl.ipynb
diff --git a/...ationReview/Urban_metrics_Structure.ipynb → ...ationReview/Urban_metrics_Structure.ipynb b/...ationReview/Urban_metrics_Structure.ipynb → ...ationReview/Urban_metrics_Structure.ipynb
diff --git a/...OG_urban_assessment/Summarize_Urban.ipynb → ...OG_urban_assessment/Summarize_Urban.ipynb b/...OG_urban_assessment/Summarize_Urban.ipynb → ...OG_urban_assessment/Summarize_Urban.ipynb
diff --git a/Notebooks/Implementations/README.md → notebooks/Implementations/README.md b/Notebooks/Implementations/README.md → notebooks/Implementations/README.md
diff --git a/...tations/Slum_Mapping/Imagery_Search.ipynb → ...tations/Slum_Mapping/Imagery_Search.ipynb b/...tations/Slum_Mapping/Imagery_Search.ipynb → ...tations/Slum_Mapping/Imagery_Search.ipynb
diff --git a/...ping/slumML/OpenBuildings2FeatureClass.py → ...ping/slumML/OpenBuildings2FeatureClass.py b/...ping/slumML/OpenBuildings2FeatureClass.py → ...ping/slumML/OpenBuildings2FeatureClass.py
diff --git a/...ementations/Slum_Mapping/slumML/README.md → ...ementations/Slum_Mapping/slumML/README.md b/...ementations/Slum_Mapping/slumML/README.md → ...ementations/Slum_Mapping/slumML/README.md
diff --git a/...entations/Slum_Mapping/slumML/STEP1.ipynb → ...entations/Slum_Mapping/slumML/STEP1.ipynb b/...entations/Slum_Mapping/slumML/STEP1.ipynb → ...entations/Slum_Mapping/slumML/STEP1.ipynb
diff --git a/...lementations/Slum_Mapping/slumML/STEP1.py → ...lementations/Slum_Mapping/slumML/STEP1.py b/...lementations/Slum_Mapping/slumML/STEP1.py → ...lementations/Slum_Mapping/slumML/STEP1.py
diff --git a/...entations/Slum_Mapping/slumML/STEP2.ipynb → ...entations/Slum_Mapping/slumML/STEP2.ipynb b/...entations/Slum_Mapping/slumML/STEP2.ipynb → ...entations/Slum_Mapping/slumML/STEP2.ipynb
diff --git a/...lementations/Slum_Mapping/slumML/STEP2.py → ...lementations/Slum_Mapping/slumML/STEP2.py b/...lementations/Slum_Mapping/slumML/STEP2.py → ...lementations/Slum_Mapping/slumML/STEP2.py
diff --git a/...ns/URB_DECAT_B_ExploringGHSSMODcode.ipynb → ...ns/URB_DECAT_B_ExploringGHSSMODcode.ipynb b/...ns/URB_DECAT_B_ExploringGHSSMODcode.ipynb → ...ns/URB_DECAT_B_ExploringGHSSMODcode.ipynb
diff --git a/...RB_SCAUR_UKR_B_I_urbanizationReview.ipynb → ...RB_SCAUR_UKR_B_I_urbanizationReview.ipynb b/...RB_SCAUR_UKR_B_I_urbanizationReview.ipynb → ...RB_SCAUR_UKR_B_I_urbanizationReview.ipynb
diff --git a/...s/URB_SEAU1_B_A_Ka_ExtractDataUrban.ipynb → ...s/URB_SEAU1_B_A_Ka_ExtractDataUrban.ipynb b/...s/URB_SEAU1_B_A_Ka_ExtractDataUrban.ipynb → ...s/URB_SEAU1_B_A_Ka_ExtractDataUrban.ipynb
diff --git a/...rbanization/Create_Mosaick_Datasets.ipynb → ...rbanization/Create_Mosaick_Datasets.ipynb b/...rbanization/Create_Mosaick_Datasets.ipynb → ...rbanization/Create_Mosaick_Datasets.ipynb
diff --git a/...ization/GHSL_Standardize_To_Country.ipynb → ...ization/GHSL_Standardize_To_Country.ipynb b/...ization/GHSL_Standardize_To_Country.ipynb → ...ization/GHSL_Standardize_To_Country.ipynb
diff --git a/..._NovelUrbanization/MAP_Urbanization.ipynb → ..._NovelUrbanization/MAP_Urbanization.ipynb b/..._NovelUrbanization/MAP_Urbanization.ipynb → ..._NovelUrbanization/MAP_Urbanization.ipynb
diff --git a/...elUrbanization/NGA_specific_results.ipynb → ...elUrbanization/NGA_specific_results.ipynb b/...elUrbanization/NGA_specific_results.ipynb → ...elUrbanization/NGA_specific_results.ipynb
diff --git a/...ons/URB_SEAU1_NovelUrbanization/README.md → ...ons/URB_SEAU1_NovelUrbanization/README.md b/...ons/URB_SEAU1_NovelUrbanization/README.md → ...ons/URB_SEAU1_NovelUrbanization/README.md
diff --git a/...zation/SSA_countries_GDP_Urbanization.csv → ...zation/SSA_countries_GDP_Urbanization.csv b/...zation/SSA_countries_GDP_Urbanization.csv → ...zation/SSA_countries_GDP_Urbanization.csv
diff --git a/...n/URB_SEAU1_B_A_Ka_NovelUrbanizaton.ipynb → ...n/URB_SEAU1_B_A_Ka_NovelUrbanizaton.ipynb b/...n/URB_SEAU1_B_A_Ka_NovelUrbanizaton.ipynb → ...n/URB_SEAU1_B_A_Ka_NovelUrbanizaton.ipynb
diff --git a/...ion/WBGAPI_Extract_urbanization_GDP.ipynb → ...ion/WBGAPI_Extract_urbanization_GDP.ipynb b/...ion/WBGAPI_Extract_urbanization_GDP.ipynb → ...ion/WBGAPI_Extract_urbanization_GDP.ipynb
diff --git a/...U1_NovelUrbanization/novelUrbanization.py → ...U1_NovelUrbanization/novelUrbanization.py b/...U1_NovelUrbanization/novelUrbanization.py → ...U1_NovelUrbanization/novelUrbanization.py
diff --git a/..._Energy_Transition/Data Preparation.ipynb → ..._Energy_Transition/Data Preparation.ipynb b/..._Energy_Transition/Data Preparation.ipynb → ..._Energy_Transition/Data Preparation.ipynb
diff --git a/...URB_SURDR_ZAF_Energy_Transition/README.md → ...URB_SURDR_ZAF_Energy_Transition/README.md b/...URB_SURDR_ZAF_Energy_Transition/README.md → ...URB_SURDR_ZAF_Energy_Transition/README.md
diff --git a/..._Energy_Transition/Zonal_statistics.ipynb → ..._Energy_Transition/Zonal_statistics.ipynb b/..._Energy_Transition/Zonal_statistics.ipynb → ..._Energy_Transition/Zonal_statistics.ipynb
diff --git a/Notebooks/Implementations/WSF/__init__.py → notebooks/Implementations/WSF/__init__.py b/Notebooks/Implementations/WSF/__init__.py → notebooks/Implementations/WSF/__init__.py
diff --git a/Notebooks/Implementations/WSF/wsfdata.py → notebooks/Implementations/WSF/wsfdata.py b/Notebooks/Implementations/WSF/wsfdata.py → notebooks/Implementations/WSF/wsfdata.py
diff --git a/...ions/WSF_DECAT_B_ExploringIDCerrors.ipynb → ...ions/WSF_DECAT_B_ExploringIDCerrors.ipynb b/...ions/WSF_DECAT_B_ExploringIDCerrors.ipynb → ...ions/WSF_DECAT_B_ExploringIDCerrors.ipynb
diff --git a/Notebooks/Tutorials/LEI_Example.ipynb → notebooks/Tutorials/LEI_Example.ipynb b/Notebooks/Tutorials/LEI_Example.ipynb → notebooks/Tutorials/LEI_Example.ipynb
diff --git a/Notebooks/Tutorials/Untitled.ipynb → notebooks/Tutorials/Untitled.ipynb b/Notebooks/Tutorials/Untitled.ipynb → notebooks/Tutorials/Untitled.ipynb
diff --git a/...ooks/Tutorials/UrbanAreas_tutorials.ipynb → ...ooks/Tutorials/UrbanAreas_tutorials.ipynb b/...ooks/Tutorials/UrbanAreas_tutorials.ipynb → ...ooks/Tutorials/UrbanAreas_tutorials.ipynb
diff --git a/.../UrbanRural_extents_from_griddedPop.ipynb → .../UrbanRural_extents_from_griddedPop.ipynb b/.../UrbanRural_extents_from_griddedPop.ipynb → .../UrbanRural_extents_from_griddedPop.ipynb
diff --git a/Notebooks/URB_DECAT_ExtractByISO3.ipynb → notebooks/URB_DECAT_ExtractByISO3.ipynb b/Notebooks/URB_DECAT_ExtractByISO3.ipynb → notebooks/URB_DECAT_ExtractByISO3.ipynb
diff --git a/Notebooks/Untitled.ipynb → notebooks/Untitled.ipynb b/Notebooks/Untitled.ipynb → notebooks/Untitled.ipynb
diff --git a/pyproject.toml b/pyproject.toml
@@ -35,7 +35,11 @@ dependencies = [
 
 [project.optional-dependencies]
 dev = ["pytest", "pytest-cov"]
-docs = ["docutils==0.17.1", "jupyter-book>=1,<2"]
+docs = [
+	"docutils==0.17.1",
+	"jupyter-book>=1,<2",
+	"sphinxcontrib-apidoc>=0.4.0,<1",
+]
 
 [project.urls]
 "Homepage" = "https://github.com/worldbank/GOSTurban"