machine_access_control 0.6.0__tar.gz

machine_access_control-0.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Jason Antman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

machine_access_control-0.6.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: machine_access_control
+Version: 0.6.0
+Summary: Decatur Makers Machine Access Control package
+License: MIT
+License-File: LICENSE
+Author: Jason Antman
+Author-email: jason@jasonantman.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: aiohttp (>=3.12.14,<4.0.0)
+Requires-Dist: asyncio (>=3.4.3,<4.0.0)
+Requires-Dist: filelock (>=3.16.1,<4.0.0)
+Requires-Dist: humanize (>=4.11.0,<5.0.0)
+Requires-Dist: jsonschema (>=4.23.0,<5.0.0)
+Requires-Dist: prometheus-client (>=0.20.0,<0.21.0)
+Requires-Dist: quart (>=0.19.8,<0.20.0)
+Requires-Dist: requests (>=2.32.4,<3.0.0)
+Requires-Dist: slack-bolt (>=1.21.3,<2.0.0)
+Requires-Dist: slack-sdk (>=3.33.5,<4.0.0)
+Project-URL: Changelog, https://github.com/jantman/machine_access_control/releases
+Project-URL: Documentation, https://github.com/jantman/machine_access_control
+Project-URL: Homepage, https://github.com/jantman/machine_access_control
+Project-URL: Repository, https://github.com/jantman/machine_access_control
+Description-Content-Type: text/x-rst
+
+Decatur Makers Machine Access Control (dm-mac)
+==============================================
+
+.. image:: https://www.repostatus.org/badges/latest/concept.svg
+   :alt: Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.
+   :target: https://www.repostatus.org/#concept
+.. image:: https://github.com/jantman/machine-access-control/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/jantman/machine-access-control/actions/workflows/tests.yml
+
+This is a software and hardware project for using RFID cards/fobs to
+control use of various power tools and equipment in the `Decatur
+Makers <https://decaturmakers.org/>`__ makerspace. It is made up of
+custom ESP32-based hardware (machine control units) controlling power to
+each enabled machine and running ESPHome, and a central access
+control/management/logging server application written in Python/Quart.
+Like our `“glue” server <https://github.com/decaturmakers/glue>`__ that
+powers the RFID-based door access control to the makerspace, dm-mac uses
+the `Neon CRM <https://www.neoncrm.com/>`__ as its source for user data,
+though that is completely optional and pluggable.
+
+For full documentation, see:
+https://jantman.github.io/machine-access-control/
+
+License
+-------
+
+Distributed under the terms of the `MIT
+license <https://github.com/jantman/machine_access_control/blob/main/LICENSE>`__,
+*Machine_Access_Control* (``dm_mac``) is free and open source software.
+

machine_access_control-0.6.0/README.rst

@@ -0,0 +1,29 @@
+Decatur Makers Machine Access Control (dm-mac)
+==============================================
+
+.. image:: https://www.repostatus.org/badges/latest/concept.svg
+   :alt: Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.
+   :target: https://www.repostatus.org/#concept
+.. image:: https://github.com/jantman/machine-access-control/actions/workflows/tests.yml/badge.svg
+   :target: https://github.com/jantman/machine-access-control/actions/workflows/tests.yml
+
+This is a software and hardware project for using RFID cards/fobs to
+control use of various power tools and equipment in the `Decatur
+Makers <https://decaturmakers.org/>`__ makerspace. It is made up of
+custom ESP32-based hardware (machine control units) controlling power to
+each enabled machine and running ESPHome, and a central access
+control/management/logging server application written in Python/Quart.
+Like our `“glue” server <https://github.com/decaturmakers/glue>`__ that
+powers the RFID-based door access control to the makerspace, dm-mac uses
+the `Neon CRM <https://www.neoncrm.com/>`__ as its source for user data,
+though that is completely optional and pluggable.
+
+For full documentation, see:
+https://jantman.github.io/machine-access-control/
+
+License
+-------
+
+Distributed under the terms of the `MIT
+license <https://github.com/jantman/machine_access_control/blob/main/LICENSE>`__,
+*Machine_Access_Control* (``dm_mac``) is free and open source software.

machine_access_control-0.6.0/pyproject.toml

@@ -0,0 +1,100 @@
+[tool.poetry]
+name = "machine_access_control"
+version = "0.6.0"
+description = "Decatur Makers Machine Access Control package"
+authors = ["Jason Antman <jason@jasonantman.com>"]
+license = "MIT"
+readme = "README.rst"
+homepage = "https://github.com/jantman/machine_access_control"
+repository = "https://github.com/jantman/machine_access_control"
+documentation = "https://github.com/jantman/machine_access_control"
+packages = [
+    { include = "dm_mac", from = "src" },
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+]
+
+[tool.poetry.scripts]
+neongetter = "dm_mac.neongetter:main"
+mac-server = "dm_mac:main"
+
+[tool.poetry.urls]
+Changelog = "https://github.com/jantman/machine_access_control/releases"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+jsonschema = "^4.23.0"
+requests = "^2.32.4"
+filelock = "^3.16.1"
+prometheus-client = "^0.20.0"
+quart = "^0.19.8"
+asyncio = "^3.4.3"
+slack-bolt = "^1.21.3"
+aiohttp = "^3.12.14"
+slack-sdk = "^3.33.5"
+humanize = "^4.11.0"
+
+[tool.poetry.group.dev.dependencies]
+Pygments = ">=2.10.0"
+black = ">=21.10b0"
+coverage = {extras = ["toml"], version = ">=6.2"}
+darglint = ">=1.8.1"
+flake8 = ">=7.1.1"
+flake8-bandit = ">=2.1.2"
+flake8-bugbear = ">=21.9.2"
+flake8-docstrings = ">=1.6.0"
+flake8-rst-docstrings = ">=0.2.5"
+furo = ">=2021.11.12"
+isort = ">=5.10.1"
+mypy = ">=0.930"
+nox = ">=2024.4.15"
+nox-poetry = ">= 1.2.0"
+pep8-naming = ">=0.12.1"
+pre-commit = ">=2.16.0"
+pre-commit-hooks = ">=4.1.0"
+pytest = ">=6.2.5"
+pyupgrade = ">=2.29.1"
+safety = ">=1.10.3"
+typeguard = ">=2.13.3"
+types-jsonschema = "^4.23.0.20240712"
+pytest-blockage = "^0.2.4"
+sphinx = "<8.0"
+sphinx-rtd-theme = "^2.0.0"
+responses = "^0.25.3"
+types-requests = "^2.32.0.20240712"
+faker = "^26.3.0"
+pytest-html = "^4.1.1"
+poetry-plugin-export = "^1.9.0"
+freezegun = "^1.5.1"
+
+[tool.isort]
+profile = "black"
+force_single_line = true
+lines_after_imports = 2
+
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+tests = ["tests", "*/tests"]
+
+[tool.coverage.run]
+branch = true
+source = ["dm_mac"]
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 5
+
+[tool.mypy]
+strict = true
+warn_unreachable = true
+pretty = true
+show_column_numbers = true
+show_error_codes = true
+show_error_context = true
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = [
+  "poetry-core>=1",
+]

machine_access_control-0.6.0/src/dm_mac/__init__.py

@@ -0,0 +1,137 @@
+"""Decatur Makers Machine Access Control."""
+
+import argparse
+import logging
+import os
+import sys
+from asyncio import AbstractEventLoop
+from asyncio import get_event_loop
+from time import time
+
+from quart import Quart
+from quart import has_request_context
+from quart import request
+from quart.logging import default_handler
+from slack_bolt.adapter.socket_mode.async_handler import AsyncSocketModeHandler
+
+from dm_mac.models.machine import MachinesConfig
+from dm_mac.models.users import UsersConfig
+from dm_mac.slack_handler import SlackHandler
+from dm_mac.utils import set_log_debug
+from dm_mac.utils import set_log_info
+from dm_mac.views.api import api
+from dm_mac.views.machine import machineapi
+from dm_mac.views.prometheus import prometheus_route
+
+
+logger: logging.Logger = logging.getLogger()
+logging.basicConfig(
+    level=logging.WARNING, format="[%(asctime)s %(levelname)s] %(message)s"
+)
+
+# BEGIN adding request information to logs
+
+
+class RequestFormatter(logging.Formatter):
+    """Custom log formatter to add request information."""
+
+    def format(self, record: logging.LogRecord) -> str:
+        """Custom log formatter to add request information."""
+        if has_request_context():
+            record.url = request.url
+            record.remote_addr = request.remote_addr
+        else:
+            record.url = None
+            record.remote_addr = None
+
+        return super().format(record)
+
+
+formatter = RequestFormatter(
+    "%(asctime)s %(levelname)s:[%(remote_addr)s]:%(name)s:%(message)s"
+)
+default_handler.setFormatter(formatter)
+
+# END adding request information to logs
+
+# enable logging from libraries (i.e. everything but the views)
+logging.getLogger().addHandler(default_handler)
+
+logging.getLogger("AUTH").setLevel(logging.INFO)
+logging.getLogger().setLevel(logging.INFO)
+
+# see: https://github.com/pallets/flask/issues/4786#issuecomment-1416354177
+api.register_blueprint(machineapi)
+
+app: Quart
+
+
+def asyncio_exception_handler(_, context):
+    # get details of the exception
+    exception = context["exception"]
+    message = context["message"]
+    # log exception
+    logger.error(f"Task failed, msg={message}, exception={exception}")
+
+
+def create_app() -> Quart:
+    """Factory to create the app."""
+    app: Quart = Quart("dm_mac")
+    app.config.update({"MACHINES": MachinesConfig()})
+    app.config.update({"USERS": UsersConfig()})
+    app.config.update({"START_TIME": time()})
+    app.config.update({"SLACK_HANDLER": None})
+    app.register_blueprint(api)
+    app.add_url_rule("/metrics", view_func=prometheus_route)
+    return app
+
+
+def main() -> None:
+    global app
+    p = argparse.ArgumentParser(description="Run Machine Access Control (MAC) server")
+    p.add_argument(
+        "-d",
+        "--debug",
+        dest="debug",
+        action="store_true",
+        default=False,
+        help="Debug mode",
+    )
+    p.add_argument(
+        "-v",
+        "--verbose",
+        dest="verbose",
+        action="store_true",
+        default=False,
+        help="verbose output",
+    )
+    p.add_argument(
+        "-P",
+        "--port",
+        dest="port",
+        action="store",
+        type=int,
+        default=5000,
+        help="Port number to listen on (default 5000)",
+    )
+    args = p.parse_args(sys.argv[1:])
+    if args.verbose:
+        set_log_debug(logger)
+    else:
+        set_log_info(logger)
+    loop: AbstractEventLoop = get_event_loop()
+    loop.set_exception_handler(asyncio_exception_handler)
+    app = create_app()
+    token: str = os.environ.get("SLACK_APP_TOKEN", "").strip()
+    if token:
+        slack: SlackHandler = SlackHandler(app)
+        app.config.update({"SLACK_HANDLER": slack})
+        handler = AsyncSocketModeHandler(
+            slack.app, os.environ["SLACK_APP_TOKEN"], loop=loop
+        )
+        loop.create_task(handler.start_async())
+    app.run(loop=loop, debug=args.debug, host="0.0.0.0", port=args.port)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

machine_access_control-0.6.0/src/dm_mac/cli_utils.py

@@ -0,0 +1,38 @@
+"""Utility functions for command-line tools."""
+
+import logging
+import os
+
+
+def set_log_info(lgr: logging.Logger) -> None:
+    """Set logger level to INFO."""
+    set_log_level_format(
+        lgr, logging.INFO, "%(asctime)s %(levelname)s:%(name)s:%(message)s"
+    )
+
+
+def set_log_debug(lgr: logging.Logger) -> None:
+    """Set logger level to DEBUG, and debug-level output format."""
+    set_log_level_format(
+        lgr,
+        logging.DEBUG,
+        "%(asctime)s [%(levelname)s %(filename)s:%(lineno)s - "
+        "%(name)s.%(funcName)s() ] %(message)s",
+    )
+
+
+def set_log_level_format(lgr: logging.Logger, level: int, fmt: str) -> None:
+    """Set logger level and format."""
+    formatter = logging.Formatter(fmt=fmt)
+    lgr.handlers[0].setFormatter(formatter)
+    lgr.setLevel(level)
+
+
+def env_var_or_die(varname: str, content: str) -> str:
+    """Return the value of an env var, or raise exception if not set."""
+    try:
+        return os.environ[varname]
+    except KeyError as ex:
+        raise RuntimeError(
+            f"ERROR: Please set the {varname} environment variable to {content}."
+        ) from ex

machine_access_control-0.6.0/src/dm_mac/models/__init__.py

@@ -0,0 +1 @@
+"""Init for models (empty)."""