{"id":19835403,"url":"https://github.com/equinor/webviz-plugin-boilerplate","last_synced_at":"2025-05-01T17:33:42.856Z","repository":{"id":41282316,"uuid":"217016827","full_name":"equinor/webviz-plugin-boilerplate","owner":"equinor","description":"Quickly get started creating webviz-config plugins :rocket:","archived":false,"fork":false,"pushed_at":"2023-10-02T12:15:45.000Z","size":52,"stargazers_count":4,"open_issues_count":7,"forks_count":6,"subscribers_count":4,"default_branch":"main","last_synced_at":"2023-12-06T16:39:33.368Z","etag":null,"topics":["dash","dashboards","flask","reusable","webviz"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/equinor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-23T09:16:36.000Z","updated_at":"2022-06-30T08:53:42.000Z","dependencies_parsed_at":"2023-01-22T10:30:39.384Z","dependency_job_id":null,"html_url":"https://github.com/equinor/webviz-plugin-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinor%2Fwebviz-plugin-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinor%2Fwebviz-plugin-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinor%2Fwebviz-plugin-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/equinor%2Fwebviz-plugin-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/equinor","download_url":"https://codeload.github.com/equinor/webviz-plugin-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224270268,"owners_count":17283649,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dash","dashboards","flask","reusable","webviz"],"created_at":"2024-11-12T12:07:56.851Z","updated_at":"2024-11-12T12:07:57.540Z","avatar_url":"https://github.com/equinor.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://github.com/equinor/webviz-plugin-boilerplate/workflows/webviz-plugin-boilerplate/badge.svg)](https://github.com/equinor/webviz-plugin-boilerplate/actions?query=branch%3Amaster)\n[![Python 3.8 | 3.9 | 3.10](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10-blue.svg)](https://www.python.org/)\n\n# Quickly get started creating plugins to `webviz-config`\n\nThis repository will quickly get you started creating your own [`webviz-config`](https://github.com/equinor/webviz-config) plugins :rocket:.\n\n\u003cbr/\u003e\n\n## Create a new Python plugin package\n\nCreating a new Python package with [`webviz-config`](https://github.com/equinor/webviz-config) plugins by pushing [`Use this template`](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)-button.\n\nConfigure new python package in repository by the following steps\n\n1. Rename project\n2. Rename/Delete existing example plugins\n\n## Install your new Python plugin package\n\nThe default package created for you contains some dummy plugins. These you can later delete/and or overwrite with your fancy plugins. You can have an arbitrary number of plugins in your package.\n\nTo install your plugin package in _development mode_, run\n\n```bash\ncd YOUR_PLUGIN_PROJECT\npip install -e .\n```\n\nThis will (first time) install all dependencies, but the `-e` flag will also make sure your plugin project is installed in edit/development mode. This means that when you update the Python files in your package, this will automatically be available in your current Python environment without having to reinstall the package.\n\n## Test your new Python plugin package\n\nAfter installation you can test the custom plugins from your package using the provided example configuration file:\n\n```bash\nwebviz build ./examples/boilerplate_example.yaml\n```\n\n\u003cbr/\u003e\n\nIf you want to install test and linting dependencies, you can in addition run\n\n```bash\npip install .[tests]\n```\n\n### Linting\n\nYou can do automatic linting of your code changes by running\n\n```bash\nblack --check webviz_plugin_boilerplate # Check code style\npylint webviz_plugin_boilerplate # Check code quality\nbandit -r webviz_plugin_boilerplate  # Check Python security best practice\n```\n\n### Usage and documentation\n\nFor general usage, see the documentation on\n[webviz-config](https://github.com/equinor/webviz-config).\n\n## Make awesome stuff :eyeglasses:\n\nYou are now ready to modify the package with your own plugins. Have fun! :cake:\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequinor%2Fwebviz-plugin-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fequinor%2Fwebviz-plugin-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fequinor%2Fwebviz-plugin-boilerplate/lists"}