Add build workflow, expand Readme

.env.sample

@@ -1,4 +1,4 @@
-NODE_HTTPS_URL=https://polygon-mainnet.g.alchemy.com/v2/TOKEN
+NODE_HTTPS_URL=https://polygon-bor-rpc.publicnode.com
 INJECT_POA_MIDDLEWARE=True
 
 MAX_BLOCK_AGE=30

.github/workflows/build-push-image.yaml

@@ -0,0 +1,33 @@
+name: Build and Push Docker Image to Google Artifact Registry
+
+on:
+  push:
+    branches-ignore:
+      - "**"
+    tags:
+      - v*
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Docker image version tag"
+        required: true
+
+run-name: ${{ github.event_name == 'workflow_dispatch' && format('Build (@{1}) inputs={0}', tojson(inputs), github.ref_name) || '' }}
+
+env:
+  IMAGE: solid-range-319205/ensuro/eth-exporter
+  REGISTRY_HOSTNAME: us-docker.pkg.dev
+
+jobs:
+  build-push:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Build and push
+        uses: ensuro/github-actions/[email protected]
+        with:
+          registry: "${{ env.REGISTRY_HOSTNAME }}"
+          image: "${{ env.IMAGE }}"
+          google_credentials: "${{ secrets.GOOGLE_CREDENTIALS }}"
+          additional_tag: "${{ github.event.inputs.version }}"

Dockerfile

@@ -0,0 +1,34 @@
+FROM python:3.10-slim
+
+# Alternatives for APP_ENV:
+# - production: for production deployment
+# - development: for local develpment environment
+# - ci: for continous integration environment
+
+RUN adduser --system --no-create-home --home=/app app
+
+ARG APP_ENV="production"
+ENV APP_ENV $APP_ENV
+
+COPY . /app
+WORKDIR /app
+
+# Required since we don't copy the .git folder into the image.
+# Production image should be built with `--arg=DOCKER_METADATA_OUTPUT_VERSION=$(python setup.py --version)` to inject the correct version into the package.
+ARG DOCKER_METADATA_OUTPUT_VERSION=0.0.1-beta1
+ENV SETUPTOOLS_SCM_PRETEND_VERSION=$DOCKER_METADATA_OUTPUT_VERSION
+
+RUN if [ $APP_ENV = "production" ]; then \
+        pip install . \
+            && rm -rf /app \
+            && mkdir -p /app; \
+    else \
+        pip install -e .; \
+    fi
+
+
+EXPOSE 8000
+
+USER app
+
+ENTRYPOINT ["python", "-m", "eth_exporter.exporter"]

README.md

@@ -2,6 +2,17 @@
 
 Prometheus exporter of blockchain data
 
+## Running with docker
+
+A `compose.yaml` file is provided to run the app + prometheus and grafana in docker.
+
+1. Copy the sample config to be used: `cp .env.sample .env`
+2. Start the containers:  `docker compose up`
+3. Services will be available on these urls:
+  - Exporter: http://localhost:8000/metrics
+  - Prometheus: http://localhost:9090
+  - Grafana: http://localhost:3000 (credentials admin:grafana)
+
 <!-- pyscaffold-notes -->
 
 ## Note

compose.yaml

@@ -1,4 +1,17 @@
 services:
+  devcontainer:
+    build:
+      context: .
+
+    command: python -m eth_exporter.exporter
+    env_file: .env
+
+    volumes:
+      - ./samples:/app/samples
+
+    ports:
+      - 8000:8000
+
   prometheus:
     image: prom/prometheus
     container_name: prometheus