add files

Author: Patrick762

.github/workflows/python-publish.yml

@@ -0,0 +1,41 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      env:
+        LIB_VERSION: ${{ github.event.release.tag_name }}
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_TOKEN }}

.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+.envrc
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

Dockerfile.test

@@ -0,0 +1,9 @@
+FROM python:3
+
+COPY requirements.txt .
+RUN pip install -r requirements.txt
+
+COPY tests ./tests
+COPY nut_base_server ./nut_base_server
+
+RUN python3 -m unittest discover -s tests -p "*_test.py"

README.md

@@ -1,2 +1,4 @@
-# nut-server
+# nut-base-server
 NUT compatible server to use with adapters for different UPS-like devices
+
+NUT Server based on [NUT Protocol Docs](https://networkupstools.org/docs/developer-guide.chunked/net-protocol.html) and the [Variables Docs](https://networkupstools.org/docs/developer-guide.chunked/_variables.html)

format.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+black --target-version py310 .

nut_base_server/__init__.py

@@ -0,0 +1,4 @@
+"""NUT Base Server exports."""
+
+from .adapter.base_adapter import BaseAdapter
+from .nut_server import NutServer

nut_base_server/adapter/__init__.py

@@ -0,0 +1,42 @@
+from nut_definitions import NutVariable
+
+
+class BaseAdapter:
+    def __init__(
+        self, name: str, description: str, static_vars: list[NutVariable] = []
+    ):
+        self.name = name
+        self.description = description
+        self.static_vars = static_vars
+
+    async def _get_nut_variable(self, name: str) -> NutVariable | None:
+        """DO NOT OVERRIDE!"""
+        all_vars = self.static_vars + await self._get_values()
+        found = [f for f in all_vars if f.name == name]
+        if len(found) == 0:
+            return None
+        return found[-1]
+
+    async def get_variable_value(self, name: str) -> str | None:
+        """DO NOT OVERRIDE!"""
+        variable = await self._get_nut_variable(name)
+        if variable is None:
+            return None
+        return variable.value
+
+    async def get_all_variables(self) -> list[NutVariable]:
+        """DO NOT OVERRIDE!"""
+        return self.static_vars + await self._get_values()
+
+    async def get_variable_type(self, name: str) -> str | None:
+        """DO NOT OVERRIDE!"""
+        variable = await self._get_nut_variable(name)
+        if variable is None:
+            return None
+        return variable.vType
+
+    def numlogins(self) -> int:
+        raise NotImplementedError()
+
+    async def _get_values(self) -> list[NutVariable]:
+        return []

nut_base_server/adapter/base_adapter.py

@@ -0,0 +1,27 @@
+import random
+
+from nut_definitions import NutVariable, DeviceType, UpsStatus
+
+from .base_adapter import BaseAdapter
+
+
+class DummyAdapter(BaseAdapter):
+    def __init__(self):
+        super().__init__(
+            "name",
+            "Description",
+            [
+                NutVariable.device_mfr("Manufacturer"),
+                NutVariable.device_model("Model"),
+                NutVariable.device_type(DeviceType.Ups),
+            ],
+        )
+
+    def numlogins(self) -> int:
+        return 0
+
+    async def _get_values(self) -> list[NutVariable]:
+        return [
+            NutVariable.ups_status([UpsStatus.Online]),
+            NutVariable.battery_charge(random.randint(50, 100)),
+        ]

nut_base_server/adapter/dummy_adapter.py

@@ -0,0 +1,2 @@
+class DisconnectRequestedException(Exception):
+    """Thrown if client wants to disconnect."""