arrowhead_alarm 1.1.0__tar.gz

arrowhead_alarm-1.1.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,55 @@
+# This workflow will upload a Python Package to PyPI 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:
+  push:
+    tags:
+      - v*
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Install Python 3.13
+        run: uv python install 3.13
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+          pip install ty
+
+      - name: Run Ruff
+        run: ruff check --output-format=github .
+
+      - name: Run Ty
+        run: ty check --output-format=github .
+
+      - name: Run tests
+        run: uv run pytest tests
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        run: uv publish

arrowhead_alarm-1.1.0/.github/workflows/python-test.yml

@@ -0,0 +1,51 @@
+# This workflow will upload a Python Package to PyPI 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: Test and Build python package
+
+on:
+  push:
+    branches:
+    - master
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        
+      - name: Install Python 3.13
+        run: uv python install 3.13
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+          pip install ty
+
+      - name: Run Ruff
+        run: ruff check --output-format=github .
+
+      - name: Run Ty
+        run: ty check --output-format=github .
+
+      - name: Run tests
+        run: uv run pytest tests
+        
+      - name: Build
+        run: uv build

arrowhead_alarm-1.1.0/.gitignore

@@ -0,0 +1,219 @@
+# 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
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Pycharm specific files
+.idea/

arrowhead_alarm-1.1.0/LICENSE

@@ -0,0 +1,41 @@
+DUAL LICENSE NOTICE
+
+This software is dual-licensed. You may use it under either:
+- License A: Non-Commercial License (free)
+- License B: Commercial License (permission required)
+
+------------------------------------------------------------
+
+License A — Non-Commercial License
+
+Copyright (c) 2025 Jonathan K.
+
+Permission is hereby granted to use, copy, modify, and distribute this
+software for non-commercial purposes only, provided that all copies
+or substantial portions of the software include:
+
+1. This copyright notice
+2. A clear reference to the original author and project (https://github.com/jonOriginal/elitecloud-alarm)
+
+Commercial use, including but not limited to use in paid products,
+services, SaaS offerings, internal business tools, or any
+revenue-generating activities, is strictly prohibited under this
+license.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED.
+
+------------------------------------------------------------
+
+License B — Commercial License
+
+Copyright (c) 2025 <Your Name>
+
+Commercial use of this software is permitted only under a separate
+commercial license agreement obtained from the copyright holder.
+
+The terms of the commercial license will be defined in a written
+agreement.
+
+To obtain a commercial license, contact:
+jonathan@telkode.com

arrowhead_alarm-1.1.0/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: arrowhead_alarm
+Version: 1.1.0
+Summary: A library for interacting with arrowhead alarm systems.
+Author-email: Jon <Jonathan@telkode.com>
+License: DUAL LICENSE NOTICE
+        
+        This software is dual-licensed. You may use it under either:
+        - License A: Non-Commercial License (free)
+        - License B: Commercial License (permission required)
+        
+        ------------------------------------------------------------
+        
+        License A — Non-Commercial License
+        
+        Copyright (c) 2025 Jonathan K.
+        
+        Permission is hereby granted to use, copy, modify, and distribute this
+        software for non-commercial purposes only, provided that all copies
+        or substantial portions of the software include:
+        
+        1. This copyright notice
+        2. A clear reference to the original author and project (https://github.com/jonOriginal/elitecloud-alarm)
+        
+        Commercial use, including but not limited to use in paid products,
+        services, SaaS offerings, internal business tools, or any
+        revenue-generating activities, is strictly prohibited under this
+        license.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+        EXPRESS OR IMPLIED.
+        
+        ------------------------------------------------------------
+        
+        License B — Commercial License
+        
+        Copyright (c) 2025 <Your Name>
+        
+        Commercial use of this software is permitted only under a separate
+        commercial license agreement obtained from the copyright holder.
+        
+        The terms of the commercial license will be defined in a written
+        agreement.
+        
+        To obtain a commercial license, contact:
+        jonathan@telkode.com
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: failure>=1.0.1
+Description-Content-Type: text/markdown
+
+# Arrowhead Alarm Library
+
+## Feature Overview
+
+## Installation Instructions
+
+## Usage Instructions
+

arrowhead_alarm-1.1.0/README.md

@@ -0,0 +1,8 @@
+# Arrowhead Alarm Library
+
+## Feature Overview
+
+## Installation Instructions
+
+## Usage Instructions
+

arrowhead_alarm-1.1.0/arrowhead_alarm/__init__.py

@@ -0,0 +1,56 @@
+"""Arrowhead alarm Integration."""
+
+from arrowhead_alarm.transport import TcpTransport
+
+from .client import EciClient
+from .types import (
+    AlarmState,
+    Area,
+    ArmingMode,
+    ConnectionState,
+    EciTransport,
+    Login,
+    Output,
+    PanelState,
+    PanelVersion,
+    VersionInfo,
+    Zone,
+)
+
+__all__ = [
+    "PanelState",
+    "AlarmState",
+    "Area",
+    "Zone",
+    "Output",
+    "ArmingMode",
+    "ConnectionState",
+    "EciTransport",
+    "Login",
+    "PanelVersion",
+    "VersionInfo",
+    "EciClient",
+]
+
+
+def create_tcp_client(
+    host: str, port: int, username: str | None = None, password: str | None = None
+) -> EciClient:
+    """Create an EciClient instance.
+
+    Args:
+        host: Hostname or IP address of the Arrowhead alarm panel.
+        port: TCP port number of the Arrowhead alarm panel.
+        username: Username for authentication.
+        password: Password for authentication.
+
+    Returns:
+        An instance of EciClient.
+
+    """
+    tcp_transport = TcpTransport(host, port)
+    if username and password:
+        creds = Login(username, password)
+    else:
+        creds = None
+    return EciClient(tcp_transport, creds)