/metricq-source-example

📦 An example source for MetricQ

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Code style: black

MetricQ example source

This is a simple example source for a MetricQ Source. It is meant to be used as a starting point for your own MetricQ source.

When using this as a template, the first thing you should do, is to rename everything from example to your desired name. This includes all file contents and filenames.

Notes about the CI as is:

  • run all formatters and linters using tox as part of building the docker images
    • black
    • isort
    • mypy
    • flake8
  • build docker images for all branches
  • build docker images for version tags vX.Y.Z
  • push docker images to ghcr.io/metricq
  • No sphinx / documentation
  • No upload to pypi