Merge pull request #5 from cern-sis/add-annaul-reports

global: addition of annual-reports

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203, E704

.github/workflows/pull-request.yaml

@@ -14,3 +14,4 @@ jobs:
         directory:
           - matomo-api
           - Library-Notification-Service
+          - annual-reports

.github/workflows/push-main.yaml

@@ -29,3 +29,5 @@ jobs:
             image-name: cern-sis/matomo-api
           - directory: Library-Notification-Service
             image-name: cern-sis/library-notifications-service
+          - directory: annual-reports
+            image-name: cern-sis/annual-reports

.github/workflows/tests.yaml

@@ -30,6 +30,9 @@ jobs:
           if [ ${{ inputs.directory }} == 'matomo-api' ]; then
             docker-compose -f matomo-api/docker-compose-tests.yaml up -d
           fi
+          if [ ${{ inputs.directory }} == 'annual-reports' ]; then
+            docker-compose -f annual-reports/docker-compose.yml up -d
+          fi
       - uses: actions/setup-python@v4
         with:
           python-version: "3.11"

.gitignore

@@ -158,3 +158,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+.DS_Store

.isort.cfg

@@ -0,0 +1,3 @@
+[settings]
+profile=black
+known_third_party = api,backoff,cli,click,freezegun,models,psycopg2,pytest,requests,sqlalchemy,structlog

.pre-commit-config.yaml

@@ -8,15 +8,10 @@ repos:
     - id: check-added-large-files
     - id: flake8
 
-  - repo: https://github.com/asottile/seed-isort-config
-    rev: v1.9.1
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
     hooks:
-    - id: seed-isort-config
-
-  - repo: https://github.com/pre-commit/mirrors-isort
-    rev: v4.3.20
-    hooks:
-    - id: isort
+      - id: isort
 
   - repo: https://github.com/python/black
     rev: stable

annual-reports/Dockerfile

@@ -0,0 +1,21 @@
+FROM python:3.8
+
+WORKDIR /matomo
+
+ENV PATH="/root/.local/bin:${PATH}"
+ENV PYTHONBUFFERED=0 \
+    POETRY_VIRTUALENVS_CREATE=false
+
+
+ARG POETRY_VERSION
+ENV POETRY_VERSION="${POETRY_VERSION:-1.6.1}"
+RUN curl -sSL https://install.python-poetry.org \
+  | python3 - --git https://github.com/python-poetry/poetry.git#{$POETRY_VERSION} \
+ && poetry --version
+
+
+COPY poetry.lock pyproject.toml ./
+COPY src ./src
+
+RUN poetry install
+CMD poetry run python src/cli.py

annual-reports/README.md

@@ -0,0 +1,24 @@
+# Annual Reports
+
+## Installation
+```
+poetry install
+docker-compose up -d
+
+export DB_PASSWORD=annual
+export DB_USER=annual
+export DB_NAME=annual
+export DB_HOST=localhost
+export DB_PORT=5432
+```
+
+## Run
+### With specific years
+```
+poetry run  python src/cli.py -y 2022 -y 2023
+```
+
+### For all years
+```
+poetry run python src/cli.py
+```

annual-reports/docker-compose.yml

@@ -0,0 +1,12 @@
+version: '3.1'
+
+services:
+  db:
+    ports:
+      - "5432:5432"
+    image: postgres:14
+    restart: always
+    environment:
+      POSTGRES_PASSWORD: annual
+      POSTGRES_USER: annual
+      POSTGRES_DB: annual

annual-reports/pyproject.toml

@@ -0,0 +1,31 @@
+[tool.poetry]
+name = "Annual Reports"
+version = "0.1.0"
+description = ""
+authors = ["CERN SIS TS"]
+packages = [
+    { include = "*", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+requests = "^2.31.0"
+click = "^8.1.7"
+pytest = "^7.4.2"
+pytest-vcr = "^1.0.2"
+urllib3 = "1.26.7"
+freezegun = "^1.2.2"
+sqlalchemy = "^2.0.22"
+sqlalchemy-utils = "^0.41.1"
+structlog = "^23.2.0"
+backoff = "^2.2.1"
+psycopg2 = "^2.9.9"
+
+[tool.poetry.dev-dependencies]
+
+[tool.poetry.group.dev.dependencies]
+ipdb = "^0.13.13"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"