Merge branch 'v3' into feature-restructure

.github/workflows/dockerhub.yml

@@ -36,6 +36,7 @@ jobs:
         with:
           context: .
           file: Containerfile
+          #platforms: linux/amd64,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

.gitignore

@@ -1,15 +1,14 @@
-# generic temporary / dev files
+# temporary / generated files
 *.pyc
-*.note
-*.xcf
-/nohup.out
-*-old
-/*.yml
-/pylintrc
-.venv/*
-/testdata*
 
-# build
+# environments / builds
+.venv/*
+testdata*
 /dist
 /build
 /*.egg-info
+
+# dev files
+*.xcf
+*.note
+*-old

example-compose.yml

@@ -0,0 +1,20 @@
+services:
+  maloja:
+    # from dockerhub
+    image: "krateng/maloja:latest"
+    # or built locally
+    #build:
+    #  context: .
+    #  dockerfile: ./Containerfile
+    ports:
+    - "42010:42010"
+    # different directories for configuration, state and logs
+    volumes:
+    - "$PWD/config:/etc/maloja"
+    - "$PWD/data:/var/lib/maloja"
+    - "$PWD/logs:/var/log/maloja"
+    #you can also have everything together instead:
+    #volumes:
+    #- "$PWD/data:/data"
+    #environment:
+    #- "MALOJA_DATA_DIRECTORY=/data"

pylintrc

@@ -0,0 +1,41 @@
+# no linting is currently enforced, this is just for reference
+[MASTER]
+disable=C0114,C0115,C0116, # docstrings
+        W0703,             # broad exception catching
+        W1514,             # open without encoding
+
+[VARIABLES]
+allow-global-unused-variables=no
+
+[BASIC]
+argument-naming-style=snake_case
+attr-naming-style=snake_case
+class-naming-style=PascalCase
+const-naming-style=UPPER_CASE
+function-naming-style=snake_case
+variable-naming-style=snake_case
+indent-string='\t'
+good-names=i,j,k, # loops
+           x,y,   # dimensions
+		   e      # exceptions
+
+max-line-length=200
+max-module-lines=1000
+
+[DESIGN]
+
+max-args=8
+max-attributes=7
+max-bool-expr=5
+max-branches=12
+max-locals=15
+max-parents=7
+max-public-methods=20
+max-returns=6
+max-statements=50
+min-public-methods=2
+
+[EXCEPTIONS]
+
+overgeneral-exceptions=BaseException,
+                       Exception