Dockerfile (#119)

* added dockerfile

* removed unneeded files

* update to python 3.11, added github action to build docker image

* revert api change

* mount .config and ensure n26 folder exists

* added comments

Author: markusressel

.github/workflows/docker-latest.yml

@@ -0,0 +1,14 @@
+name: Docker Image latest
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+
+  dockerhub:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Build the Docker image
+        run: docker build . --file Dockerfile --tag femueller/python-n26:latest

Dockerfile

@@ -0,0 +1,19 @@
+# Docker image for n26
+
+# dont use alpine for python builds: https://pythonspeed.com/articles/alpine-docker-python/
+FROM python:3.11-slim-buster
+
+WORKDIR /app
+
+COPY . .
+
+RUN apt-get update \
+    && apt-get -y install sudo python3-pip \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+RUN pip install --upgrade pip;\
+    pip install pipenv;\
+    PIP_IGNORE_INSTALLED=1 pipenv install --system --deploy;\
+    pip install .
+
+ENTRYPOINT [ "n26" ]
+CMD [ "-h" ]

Pipfile

@@ -20,4 +20,4 @@ mock = "*"
 flake8 = "*"
 
 [requires]
-python_version = "3.10"
+python_version = "3.11"

README.md

@@ -116,6 +116,19 @@ layout you can use the global `-json` parameter:
 }
 ```
 
+### Docker
+
+```shell
+# ensure the n26 folder exists
+mkdir ~/.config/n26
+# mount the config and launch the command
+sudo docker run -it --rm \
+  -v "/home/markus/.config/n26.yaml:/app/n26.yaml" \
+  -v "/home/markus/.config/n26:/.config/n26" \
+  -u 1000:1000 \
+  femueller/python-n26
+```
+
 ### API example
 
 ```python
@@ -141,6 +154,8 @@ api_client = Api(conf)
 print(api_client.get_balance())
 ```
 
+
+
 ## Contribute
 
 If there are any issues, bugs or missing API endpoints, feel free to contribute by forking the project and creating a Pull-Request.

example.py

@@ -0,0 +1,4 @@
+from n26 import api
+
+if __name__ == '__main__':
+    API_CLIENT = api.Api()