setup

.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Run Tests
+
+on: [push]
+
+jobs:
+  checker:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - name: set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: "pip"
+      - name: install dependencies
+        run: |
+          pip install -r requirements-dev.txt
+      - name: pre-commit, mypy & pylint
+        run: |
+          pre-commit run --all-files
+          mypy ./field_friend --non-interactive
+          # pylint ./field_friend
+  pytest:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+          cache: "pip"
+      - run: pip install -e . -r requirements-dev.txt
+      - name: run pytests
+        env:
+          PYTHONPATH: ${{ github.workspace }}
+        run: pytest

.gitignore

@@ -1,162 +1,4 @@
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# poetry
-#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
-#   This is especially recommended for binary packages to ensure reproducibility, and is more
-#   commonly ignored for libraries.
-#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
-#poetry.lock
-
-# pdm
-#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
-#pdm.lock
-#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
-#   in version control.
-#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
-.pdm.toml
-.pdm-python
-.pdm-build/
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
+env
+__pycache__
 .venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-# PyCharm
-#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
-#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
-#  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

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+default_language_version:
+  python: python3.11
+default_install_hook_types: [pre-commit, pre-push]
+default_stages: [pre-commit]
+
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: double-quote-string-fixer

.syncignore

@@ -0,0 +1,18 @@
+__pycache__/
+*.swp
+.env
+gphoto/resumable_uploads.db
+gphoto/uploads.db
+gphoto/[email protected]
+.pytest_cache/
+.vscode/
+.github/
+tests/
+config.hjson
+backups/
+fleet/
+.git/
+.mypy_cache/
+.ruff_cache/
+.venv/
+.DS_Store

Dockerfile

@@ -0,0 +1,43 @@
+FROM python:3.11.2-bullseye
+
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked \
+    apt update && apt install -y \
+    sudo vim less ack-grep rsync wget curl cmake arp-scan iproute2 iw libgeos-dev graphviz graphviz-dev v4l-utils psmisc sysstat \
+    libgl1-mesa-glx ffmpeg libsm6 libxext6 \
+    avahi-utils iputils-ping \
+    jq \
+    libusb-1.0-0 libusb-1.0-0-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+ARG USERNAME=stl_storage
+ARG USER_UID=1000
+ARG USER_GID=1000
+
+RUN addgroup --gid $USER_GID $USERNAME \
+    && useradd --uid $USER_UID --gid $USER_GID -m $USERNAME \
+    && usermod -a -G dialout $USERNAME \
+    && usermod -a -G tty $USERNAME \
+    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \
+    && chmod 0440 /etc/sudoers.d/$USERNAME
+
+USER $USERNAME
+
+ENV PATH="/home/${USERNAME}/.local/bin:${PATH}"
+
+RUN python3 -m pip install --upgrade pip
+
+WORKDIR /app
+COPY requirements.txt ./
+
+RUN --mount=type=cache,target=/home/zauberzeug/.cache/pip \
+    python3 -m pip install --user -r requirements.txt
+
+
+WORKDIR /app
+COPY --chown=${USERNAME}:${USER_GID} stl_storage ./stl_storage/
+COPY --chown=${USERNAME}:${USER_GID} *.py ./
+
+RUN sudo setcap 'cap_net_bind_service=+ep cap_sys_nice=+ep' /usr/local/bin/python3.11
+
+CMD python3 main.py

docker-compoe.yml

@@ -0,0 +1,18 @@
+services:
+  stl_storage:
+    build: .
+    volumes:
+      - ./:/app
+    network_mode: host
+    restart: unless-stopped
+    environment:
+      - TZ=Europe/Amsterdam
+
+    hostname: docker
+    cap_add:
+      - NET_BIND_SERVICE
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "200m"
+        max-file: "100"

main.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+import os
+
+from dotenv import load_dotenv
+from nicegui import app, ui
+
+
+load_dotenv('.env')
+
+def startup() -> None:
+    @ui.page('/')
+    def page() -> None:
+        ui.label('Hello World')
+
+app.on_startup(startup)
+ui.run(title='STL Storage', port=80)