https://github.com/osgeo/grass-addon-cookiecutter

GRASS GIS addon template powered by Cookiecutter
https://github.com/osgeo/grass-addon-cookiecutter

grass-gis grass-gis-addons

Last synced: about 1 month ago
JSON representation

GRASS GIS addon template powered by Cookiecutter

• Host: GitHub
• URL: https://github.com/osgeo/grass-addon-cookiecutter
• Owner: OSGeo
• License: gpl-2.0
• Created: 2024-06-18T16:15:28.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T18:45:17.000Z (4 months ago)
• Last Synced: 2024-11-11T08:15:30.107Z (about 1 month ago)
• Topics: grass-gis, grass-gis-addons
• Language: Python
• Homepage:
• Size: 12.7 KB
• Stars: 2
• Watchers: 16
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GRASS GIS Addon Cookiecutter

GRASS GIS addon template powered by

[Cookiecutter](https://github.com/cookiecutter/cookiecutter)

helps you get started with developing a GRASS addon.

## How to use it

1. Install cookicutter e.g. with `pipx install cookiecutter`.

2. Go to a folder where you want the addon template to be generated.

3. Run `cookiecutter gh:OSGeo/grass-addon-cookiecutter`.

4. It will prompt you with several questions (addon name, your name, ...)

5. Done, your addon template is ready for development!

## Code structure

Example code structure for a generated addon:

```

r.myaddon

├── Makefile

├── r.myaddon.html

├── r.myaddon.ipynb

├── r.myaddon.py

└── testsuite

    └── test_r_myaddon.py

```

## License

This program is free software; you can redistribute it and/or modify it

under the terms of the GNU General Public License as published by the

Free Software Foundation; either version 2 of the License, or (at your

option) any later version.

SPDX-License-Identifier: GPL-2.0-or-later