#!/usr/bin/python

def main():
    print("Created simple addon")


if __name__ == "__main__":
    main()
            

t.fossgis.fortune/
├── Makefile
├── t.fossgis.fortune.html
└── t.fossgis.fortune.py
        

MODULE_TOPDIR = ../..
PGM = t.fossgis.fortune
include $(MODULE_TOPDIR)/include/Make/Script.make
default: script
        

Vorgehen

• Abgucken oder kopieren, z.B. v.example


• Anleitung befolgen, z.B.
  How-to-create-a-GRASS-GIS-addon.md

v.example --> umbenennen
├── .flake8
├── .git [...]
├── .github
│   └── workflows
│       └── linting.yml
├── .pre-commit-config.yaml
├── .pylintrc
├── .pylintrc_allowed_to_fail
├── Makefile
├── README.md
├── renovate.json
├── testsuite
│   ├── data
│   │   ├── README.md
│   │   └── area_beuel.geojson
│   └── test_v_example.py
├── v.example.html --> umbenennen
├── v.example.py --> umbenennen
└── v_example.png
        

1. Dokumentation

• t.fossgis.fortune.html anpassen und um ausführliche Beschreibung ergänzen

• auch gerne mit Bildern versehen (v.example.png)

<h2>DESCRIPTION</h2>
<em>t.fossgis.fortune</em>
prints fortune cookie sayings.

<h2>SEE ALSO</h2>
<em>
<a href="g.message.html">
g.message</a>
</em>

<h2>AUTHOR</h2>
Carmen Tawalika, mundialis, Germany
        

GRASS nc_spm_08/fossgis > g.extension extension=t.fossgis.fortune url=t.fossgis.fortune
WARNING: Extension <t.fossgis.fortune> already installed. Re-installing...
[...]
Installation of <t.fossgis.fortune> successfully finished

GRASS nc_spm_08/fossgis > t.fossgis.fortune --help
Prints fortune cookie sayings.

Usage:
 t.fossgis.fortune [-v] [input=name] [box=value] [--help] [--verbose]
   [--quiet] [--ui]

Flags:
  -v   Print fortune version and exit

Parameters:
  input   Name of input vector map
    box   Width and height
          default: 10,10

GRASS nc_spm_08/fossgis > t.fossgis.fortune
Sanity and insanity overlap a fine grey line.

• mundialis/github-workflows
• Linting

[flake8]
# E402 module level import not at top of file
# F821 undefined name '_'
exclude = .git
max-line-length = 80
per-file-ignores =
    ./v.example.py: F821, E402

name: Python Flake8, black and pylint code quality check
on: [push, pull_request]
jobs:
  lint:
    uses: mundialis/github-workflows/
          .github/workflows/linting.yml@main
        

• mundialis/github-workflows
• pre-commit Hooks fürs Linting
• Auto-update workflow Version (renovate)

repos:
-   repo: https://github.com/mundialis/github-workflows
    rev: 1.0.3
    hooks:
    -   id: linting

{
    "$schema": "https://docs.renovatebot.com/
                renovate-schema.json",
    "extends": [
        "config:base"
    ],
    "pre-commit": {
        "enabled": true
    }
}

• mundialis/github-workflows
• Tests

name: Run tests for GRASS GIS addons
on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  tests:
    uses: mundialis/github-workflows/.github/
          workflows/grass-tests.yml@grass-tests
    # set NC_TEST_DATA to 'NC' for using
    # NC GRASS GIS sample location
    with:
      NC_TEST_DATA: 'NC'