| Name | grafana-gridder JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Create Grid layouts for Grafana dashboards. |
| upload_time | 2024-05-04 12:51:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Eduard Dranca Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
grafana
grid
dashboard
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Grafana Gridder
---
The Grafana Gridder is a grafanalib wrapper designed to simplify the organization and layout of panels within Grafana dashboards.
It provides an intuitive way to define and position groups of panels in a grid layout, making it easier to create visually appealing and organized dashboards.
### Features
* Panel Grouping: Define groups of panels that can be positioned together within a dashboard.
* Flexible Layout: Supports flexible grid layouts, allowing panels to be arranged in rows with customizable widths and heights.
* Vertical Positioning: Easily position panel groups vertically within a dashboard.
* Intuitive API: Simple and easy-to-use API for defining panel layouts and positioning.
### Example
```python
from grafanalib.core import Dashboard, TimeSeries, BarGauge, RowPanel
from grafana_gridder import PanelGroup, PanelPositioning, PanelSize
# Define panel groups
panel_group1 = PanelGroup(
layout=[[PanelSize.LARGE, PanelSize.MEDIUM], [PanelSize.SMALL, PanelSize.SMALL]],
panels=[TimeSeries(), TimeSeries(), BarGauge(), BarGauge()])
panel_group2 = PanelGroup(
layout=[PanelSize.SMALL, PanelSize.MEDIUM, PanelSize.MEDIUM],
panels=[TimeSeries(), TimeSeries(), TimeSeries()],
row=RowPanel(title="RowTitle"))
# Create panel positioning
positioning = PanelPositioning(panel_groups=[panel_group1, panel_group2])
# Generate dashboard
dashboard = Dashboard(
title='My Dashboard',
panels=positioning.panels
)
```
### Installation
You can install the Grafana Panel Layout Wrapper using pip:
```shell
pip install grafana_gridder
```
Raw data
{
"_id": null,
"home_page": null,
"name": "grafana-gridder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "grafana, grid, dashboard",
"author": null,
"author_email": "Eduard Dranca <ggridder@proton.me>",
"download_url": "https://files.pythonhosted.org/packages/84/44/4176d2609cfc3a505d3edc880f78fc60625b3b6c1cf4bdf022f0130ca10d/grafana_gridder-0.1.0.tar.gz",
"platform": null,
"description": "Grafana Gridder\n---\n\nThe Grafana Gridder is a grafanalib wrapper designed to simplify the organization and layout of panels within Grafana dashboards.\nIt provides an intuitive way to define and position groups of panels in a grid layout, making it easier to create visually appealing and organized dashboards.\n\n### Features\n* Panel Grouping: Define groups of panels that can be positioned together within a dashboard.\n* Flexible Layout: Supports flexible grid layouts, allowing panels to be arranged in rows with customizable widths and heights.\n* Vertical Positioning: Easily position panel groups vertically within a dashboard.\n* Intuitive API: Simple and easy-to-use API for defining panel layouts and positioning.\n\n### Example\n```python\nfrom grafanalib.core import Dashboard, TimeSeries, BarGauge, RowPanel\nfrom grafana_gridder import PanelGroup, PanelPositioning, PanelSize\n\n# Define panel groups\npanel_group1 = PanelGroup(\n layout=[[PanelSize.LARGE, PanelSize.MEDIUM], [PanelSize.SMALL, PanelSize.SMALL]],\n panels=[TimeSeries(), TimeSeries(), BarGauge(), BarGauge()])\npanel_group2 = PanelGroup(\n layout=[PanelSize.SMALL, PanelSize.MEDIUM, PanelSize.MEDIUM],\n panels=[TimeSeries(), TimeSeries(), TimeSeries()],\n row=RowPanel(title=\"RowTitle\"))\n\n# Create panel positioning\npositioning = PanelPositioning(panel_groups=[panel_group1, panel_group2])\n\n# Generate dashboard\ndashboard = Dashboard(\n title='My Dashboard',\n panels=positioning.panels\n)\n```\n\n### Installation\nYou can install the Grafana Panel Layout Wrapper using pip:\n\n```shell\npip install grafana_gridder\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Eduard Dranca Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Create Grid layouts for Grafana dashboards.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/EduardDranca/GrafanaGridder",
"Issues": "https://github.com/EduardDranca/GrafanaGridder/issues"
},
"split_keywords": [
"grafana",
" grid",
" dashboard"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "307178eb34b8dc5a59139f29c7a6574f199b4817996fb26685eb2dd422d8c56e",
"md5": "4d1f86fb530a07041af5953fafa01dd3",
"sha256": "d159d37ec5228960c394b598e4271fe0bb6d1aae500c641d86d9a8e594556e5d"
},
"downloads": -1,
"filename": "grafana_gridder-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4d1f86fb530a07041af5953fafa01dd3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5513,
"upload_time": "2024-05-04T12:51:54",
"upload_time_iso_8601": "2024-05-04T12:51:54.873280Z",
"url": "https://files.pythonhosted.org/packages/30/71/78eb34b8dc5a59139f29c7a6574f199b4817996fb26685eb2dd422d8c56e/grafana_gridder-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "84444176d2609cfc3a505d3edc880f78fc60625b3b6c1cf4bdf022f0130ca10d",
"md5": "f20f7720f2b3c892a43b64f15160ce93",
"sha256": "0f9c8cb06094c2bb81db707ba8db50472dc8954229ece719bbe05caf16573137"
},
"downloads": -1,
"filename": "grafana_gridder-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f20f7720f2b3c892a43b64f15160ce93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6742,
"upload_time": "2024-05-04T12:51:56",
"upload_time_iso_8601": "2024-05-04T12:51:56.316483Z",
"url": "https://files.pythonhosted.org/packages/84/44/4176d2609cfc3a505d3edc880f78fc60625b3b6c1cf4bdf022f0130ca10d/grafana_gridder-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-04 12:51:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "EduardDranca",
"github_project": "GrafanaGridder",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "grafana-gridder"
}
