Best practice on plugin code structure and removing `cookiecutter` - Githubissues

equinor / webviz-plugin-boilerplate

Quickly get started creating webviz-config plugins :rocket:

GNU Lesser General Public License v3.0

5 stars 6 forks source link

Best practice on plugin code structure and removing `cookiecutter` #19

Closed jorgenherje closed 2 years ago

jorgenherje commented 2 years ago

Add best practice code structure plugin BestPracticePlugin with detailed documentation and remove cookiecutter

Closing: https://github.com/equinor/webviz-plugin-boilerplate/issues/17

Todo:

Adjust and verify README.md
Update .github/workflows
Determine: Keep or remove old plugins? Update examples accordingly
Set BestPracticePlugin as default page plugin in example?
Set GitHub-repo as template repo
Add a link/reference to a webviz-subsurface plugin showing the split for a complex case.

Done:

Removed usage of cookiecutter, preparing for GitHub template repo
Restructuring folders
Added BestPracticePlugin - suggesting a best practice code structure for plugins, with description of file structure
Renamed example config file: boilerplate_example.yaml (Added BestPracticePlugin)