dependencies setup fails on github actions

[andresfchamorro]

Describe the bug
Once Ben added python code, the template failed to push to GH pages due to an error with dependencies. Is this happening because of pip install -e.?

To Reproduce
https://github.com/worldbank/Boundary_Comparison/actions/runs/4368078130/jobs/7640202293

Expected behavior
To be discussed

• Set up the default template so that no unnecessary packages are installed for building docs
• Is it better to use miniconda or setup-python?

[g4brielvs]

@andresfchamorro Thanks! The workflow failed because the Python package is missing (and the dependency was not removed). The template aims to encourage attention to reproducibility. In particular, to bring to the spotlight the importance of managing dependencies, packaging and distributing Python libraries and applications.

For instance, #2 contains a suggested approach to improve the release. By releasing the code as a Python package (with metadata, version and dependencies), we'd encourage maintainability and collaboration; in other words, someone who's looking to reuse the code can more easily install (or even contribute). In future, I hope to encourage enhanced versioning and release management as well towards a more reusable, robust and trustworthy codebase.

For instance, with #2, the code is now pip-installable (and it can be released on Python Package Index, if desired).

pip install git+https://github.com/worldbank/Boundary_Comparison

And, anyone can use it as shown in the snippet below. However, it will failed because GOSTRocks is not available as a package. If amenable, I'd be more than happy to help packaging and releasing it.

from GOSTboundaries.boundary_helper import country_boundary

Also, I see that the workflow may be trying to accomplish too many things: (1) documentation templating and (2) encourage reproducibility. I'm now inclined to drop the current workflow in favor of one that only serves (1). I'll adjust the template accordingly. This is excellent feedback and I look forward to continuing the discussion!