[GRASS-user] Example project for a GRASS GIS module on GitHub
wenzeslaus at gmail.com
Wed Jan 29 17:31:29 PST 2020
Dear users and contributors,
I've created an example project (repository) on GitHub. It is a GRASS GIS
module written in Python which simply adds two raster maps together. It
uses GitHub Actions to build the module and publish its documentation as a
website (using GitHub Pages).
This is based on my earlier work on an example project on GitLab  and
includes several improvements and changes:
* There is a test suite included with couple of test functions.
* It uses Black for code formatting (assuming author runs it manually).
* Repository is marked as a template (see the big "Use this template"
* GitHub Actions are used for:
* compiling the module and running tests,
* checking code quality with Flake8 and Pylint, and
* checking code style with Black.
* GitHub Actions are now used for publishing documentation (done by GitLab
* Option names now follow GRASS GIS standards more.
* More documentation in the code and on how to use the code.
* Badges are now in the README file (GitLab had those as project
Otherwise, I hope the project should describe itself and if something is
missing or is not documented enough, please open an issue or a pull request.
PS: We can discuss on grass-dev if this should go under some organization
and how to improve the "what's next" part .
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the grass-user