Update the grafana dashboard templater (#1)

* Add unittests
* Add/ Update GitHub actions
* Add docstrings
* Add dashboard example
* Update tests, src, documentation, github actions and add setup.py
* Update the documentation and Github actions
* Update the tests and setup.py
* Update the README.md
* Add coverage badge

Author: ZPascal

.coveragerc

@@ -0,0 +1,26 @@
+[run]
+branch = True
+omit =
+    */setup.py
+    */dashboard.json.sample
+    tests/*
+source = .
+
+[report]
+omit =
+     */setup.py
+     */dashboard.json.sample
+     tests/*
+fail_under = 80
+show_missing = True
+skip_covered = False
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if __name__ == .__main__.:

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+ignore = E203, E266, E501, W503
+max-line-length = 120
+max-complexity = 20
+select = B,C,D,E,F,W,T4,B902,B950
+exclude = venc,.git

.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,48 @@
+name: Build and publish
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+
+  build-and-publish:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.x']
+
+    steps:
+      - name: Checkout the repository and the branch
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          cache: 'pip'
+
+      - name: Install the requirements
+        run: pip install -r requirements.txt
+
+      - name: Install pypa/build
+        run: >-
+          python -m
+          pip install
+          build
+          --user
+
+      - name: Build a binary wheel and a source tarball
+        run: >-
+          python -m
+          build
+          --sdist
+          --wheel
+          --outdir dist/
+
+      - name: Publish distribution package to PyPI
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/pull-request-checks.yml

@@ -0,0 +1,114 @@
+name: PR checks
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.x' ]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          cache: 'pip'
+
+      - name: Install the requirements
+        run: pip install -r requirements.txt
+
+      - name: Execute the unittests
+        run: python3 -m unittest discover tests
+
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.x' ]
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          cache: 'pip'
+
+      - name: Install the requirements
+        run: pip install -r requirements.txt
+
+      - name: Execute the linting checks
+        uses: reviewdog/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          flake8_args: --config=.flake8
+
+  coverage:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.x' ]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          persist-credentials: false
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: x64
+          cache: 'pip'
+
+      - name: Install the requirements
+        run: pip install -r requirements.txt && pip install pytest pytest-cov coverage-badge
+
+      - name: Generate the coverage report
+        run: export PYTHONPATH=$PWD && pytest --junitxml=pytest.xml --cov=. tests/ | tee pytest-coverage.txt
+
+      - name: Execute the coverage checks
+        uses: MishaKav/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          pytest-coverage-path: ./pytest-coverage.txt
+          junitxml-path: ./pytest.xml
+          hide-badge: true
+          create-new-commit: true
+
+      - name: "Check if coverage badge file existence"
+        id: check_files
+        uses: andstor/file-existence-action@v1
+        with:
+          files: "docs/coverage.svg"
+
+      - name: Generate coverage badge
+        if: steps.check_files.outputs.files_exists == 'false'
+        run: coverage-badge -o docs/coverage.svg -f
+
+      - name: Commit files
+        if: steps.check_files.outputs.files_exists == 'false'
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add --force docs/coverage.svg
+          git commit -m "Add coverage badge"
+
+      - name: Push changes
+        if: steps.check_files.outputs.files_exists == 'false'
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.head_ref }}
+          force: true

README.md

@@ -1,15 +1,35 @@
-# grafana_dashboard_templater
+# Grafana dashboard templater ![Coverage report](docs/coverage.svg)
 
-## TODO
-- Documentation
-- Docstrings
-- PYPI support
+## Description
 
-## Installation & Requirements
+The Grafana dashboard templater create a valid Grafana dashboard as dictionary based on a template and injected values.
 
-### Programs & tools to install
+## Dashboard template folder structure
 
-- Jinja2
+```
+dashboard-templates <- Folder of the dashboard templates
+     database <- Dashboard type
+        postgresql <- Dashboard name
+            v13 <- Dashboard version
+                dashboard.json.sample <- Dashboard template
+```
+
+## Installation
+
+`pip install grafana-dashboard-templater`
+
+## Example
+
+```python
+from grafana_dashboard.model import Model
+from grafana_dashboard.dashboard import Dashboard
+
+dashboard_model: Model = Model(dashboard_templates_path="./dashboard-templates", dashboard_type="database",
+                               dashboard_name="postgresql", dashboard_version="v13")
+
+dashboard: Dashboard = Dashboard(dashboard_model)
+dashboard_json = dashboard.get_dashboard_json(template_values={"app_name": "PostgreSQL", "prometheus_name": "k8s-sonarqube-postgresql"})
+```
 
 ## Contribution
 If you would like to contribute something, have an improvement request, or want to make a change inside the code, please open a pull request.

docs/.placeholder

@@ -0,0 +1,27 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="grafana-dashboard-templater",
+    version="0.0.1",
+    author="Pascal Zimmermann",
+    author_email="[email protected]",
+    description="A Grafana dashboard templater",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/ZPascal/grafana_dashboard_templater",
+    project_urls={
+        "Bug Tracker": "https://github.com/ZPascal/grafana_dashboard_templater/issues",
+    },
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: Apache 2.0 License",
+        "Operating System :: OS Independent",
+    ],
+    package_dir={"": "src"},
+    packages=setuptools.find_packages(where="src"),
+    install_requires=["jinja2"],
+    python_requires=">=3.6",
+)