diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml new file mode 100644 index 0000000..fc6b0d1 --- /dev/null +++ b/.github/workflows/python-package.yml @@ -0,0 +1,37 @@ +# This workflow will install Python dependencies, run tests and lint with a variety of Python versions +# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions + +name: Python package + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + build: + + runs-on: ubuntu-latest + strategy: + matrix: + python-version: [3.7, 3.8] + + steps: + - uses: actions/checkout@v2 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements-dev.txt + - name: Lint + run: | + black quart_prometheus_logger.py utils.py --check + mypy quart_prometheus_logger.py utils.py + pylint quart_prometheus_logger.py utils.py + - name: Test with pytest + run: | + pytest diff --git a/quart_prometheus_logger.py b/quart_prometheus_logger.py index 5d86851..226197b 100644 --- a/quart_prometheus_logger.py +++ b/quart_prometheus_logger.py @@ -63,6 +63,7 @@ def __init__(self, app: Optional[Quart] = None, metrics_endpoint: str = "root"): :param metrics_endpoint: The endpoint that will be scraped by Prometheus, under this endpoint, the /metrics url will be registered, defaults to "root" """ + # TODO: Add custom metrics support self._collectors: Dict[str, MetricType] = {} self._custom_labeler: Optional[Callable[["LocalProxy"], Dict[str, str]]] = None self._custom_label_names: List[str] = []