emodul 0.1.0__tar.gz

emodul-0.1.0/.github/FUNDING.yml

@@ -0,0 +1,11 @@
+# Enable GitHub Sponsors / external funding links to appear on the repo
+# sidebar. Uncomment + fill in only what you actually use — leaving keys
+# commented hides the "Sponsor this project" button entirely.
+#
+# Reference: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository
+
+github: [hculap]                   # Your GitHub Sponsors handle
+# ko_fi: yourhandle                # https://ko-fi.com/yourhandle
+# buy_me_a_coffee: yourhandle      # https://buymeacoffee.com/yourhandle
+# patreon: yourhandle              # https://patreon.com/yourhandle
+# custom: ['https://example.com/donate']

emodul-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,55 @@
+name: Bug report
+description: Something doesn't work as expected
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for the report! Before submitting, please **anonymise** your
+        output — do not paste your JWT, `user_id`, `udid`, full controller
+        name, or other personal data.
+
+  - type: input
+    id: version
+    attributes:
+      label: emodul version
+      description: Output of `emodul --version`
+      placeholder: "emodul, version 0.1.0"
+    validations:
+      required: true
+
+  - type: input
+    id: controller
+    attributes:
+      label: Controller model
+      description: From `emodul --json modules list` (the `version` field)
+      placeholder: "TECH: L-4X WIFI (v.1.0.13)"
+    validations:
+      required: true
+
+  - type: textarea
+    id: command
+    attributes:
+      label: Exact command + output
+      description: |
+        Paste the command and its stdout/stderr. Run with `--json` if
+        possible so the output is parseable.
+      render: shell
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+    validations:
+      required: true
+
+  - type: textarea
+    id: env
+    attributes:
+      label: Environment
+      description: macOS / Linux distro, Python version, anything special
+      placeholder: "macOS 14.5, Python 3.12.3"
+    validations:
+      required: false

emodul-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,36 @@
+name: Feature request
+description: Suggest a new command, flag, or supported endpoint
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem does this solve?
+      description: Describe the use case in 1-3 sentences.
+    validations:
+      required: true
+
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: |
+        Concrete command shape if you have one, e.g.
+        `emodul zones export --format ical`
+    validations:
+      required: true
+
+  - type: input
+    id: endpoint
+    attributes:
+      label: Relevant eModul API endpoint (if you know it)
+      placeholder: "GET /api/v1/users/{user_id}/modules/{udid}/..."
+    validations:
+      required: false
+
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives you considered
+    validations:
+      required: false

emodul-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  smoke:
+    name: Install + smoke test on Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+
+      - name: Verify CLI entrypoint
+        run: |
+          emodul --version
+          emodul --help
+
+      - name: Verify every subcommand has --help (no import errors)
+        run: |
+          for cmd in auth modules zones menu settings schedules stats alarms tiles watch; do
+            echo "--- $cmd ---"
+            emodul "$cmd" --help
+          done
+
+      - name: Verify Python package imports cleanly
+        run: |
+          python -c "import emodul; from emodul import api, auth, config, format, i18n, settings_map, storage; print('all modules import ok')"
+
+  lint:
+    name: Lint with ruff
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install ruff
+        run: pip install ruff
+
+      - name: Check style + obvious errors
+        run: ruff check emodul/ --select=E,F,I,B --ignore=E501

emodul-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,55 @@
+name: Publish to PyPI
+
+# Triggered when you push a tag like `v0.2.0`.
+# Requires PYPI_API_TOKEN secret to be set in repo settings:
+#   Settings → Secrets and variables → Actions → New repository secret
+#   Name:  PYPI_API_TOKEN
+#   Value: <token from https://pypi.org/manage/account/token/>
+#
+# Or use OIDC trusted publishing (preferred): https://docs.pypi.org/trusted-publishers/
+# In which case remove the `password:` line and set `id-token: write` permission.
+
+on:
+  push:
+    tags: ["v*.*.*"]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build sdist + wheel
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tooling
+        run: pip install build
+
+      - name: Build
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Upload to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/emodul/
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

emodul-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+dist/
+build/
+.pytest_cache/
+
+# Local config and any saved API dumps (contain tokens / personal data)
+benchamr/
+probes/
+config.local.json
+*.token
+.env

emodul-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,54 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the project maintainer by opening a confidential issue or
+contacting the repository owner directly via GitHub.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html

emodul-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,88 @@
+# Contributing
+
+Thanks for considering a contribution! This project is small and pragmatic —
+issues, PRs, and ideas are welcome.
+
+## Quick start (dev setup)
+
+```bash
+git clone https://github.com/hculap/emodul.git
+cd emodul
+python3 -m venv .venv
+.venv/bin/pip install -e .
+.venv/bin/emodul --help
+```
+
+## Before opening a PR
+
+- **Match the existing style.** Small files, immutable patterns, no
+  unnecessary abstractions.
+- **No tests required for trivial changes** but if you touch HTTP/API
+  shapes please verify against your own eModul account.
+- **Don't commit secrets.** `~/.config/emodul/config.json`, any JWT, the
+  `benchamr/` dump, anything in `probes/` — all are `.gitignore`d, keep
+  it that way.
+- **Squash before merge.** One feature = one commit.
+
+## Architecture overview
+
+- `emodul/api.py` — every endpoint is a method on `ApiClient`. Add new
+  endpoints here first.
+- `emodul/commands/*.py` — one click subcommand group per file.
+- `emodul/settings_map.py` — named-slug settings inventory; add new
+  controller parameters here.
+- `emodul/storage.py` — SQLite schema for the watcher; bump cautiously
+  (no migrations framework yet).
+
+See [README.md § Architecture](README.md#architecture) for full layout.
+
+## Reporting bugs
+
+Use the bug-report issue template. Include:
+- `emodul --version`
+- Controller model (visible via `emodul --json modules list`)
+- Exact command + `--json` output
+- Stderr (API errors print there)
+
+**Do not paste your JWT, `user_id`, `udid` or controller name** in public
+issues — anonymise first.
+
+## Adding support for a new controller
+
+The CLI is tested on **L-4X WIFI** but the API surface is shared across
+most Tech controllers (L-8, L-9, L-12, etc.). If your controller exposes
+endpoints we don't wrap:
+
+1. Find the call in your browser DevTools (F12 → Network → XHR on
+   emodul.pl).
+2. Replicate via `emodul raw <METHOD> <path>` first.
+3. Once confirmed, add the method to `emodul/api.py` and a wrapping
+   command to `emodul/commands/`.
+4. If the parameter belongs to a menu, add a friendly slug in
+   `emodul/settings_map.py`.
+
+## Recording a demo
+
+```bash
+brew install asciinema     # macOS
+# OR
+apt install asciinema      # Ubuntu
+
+asciinema rec demo.cast
+# ... run a few emodul commands ...
+# Ctrl-D to stop
+
+# Upload (optional):
+asciinema upload demo.cast
+```
+
+For animated GIF use [`agg`](https://github.com/asciinema/agg):
+
+```bash
+agg demo.cast demo.gif
+```
+
+## Code of conduct
+
+This project follows the
+[Contributor Covenant v2.1](CODE_OF_CONDUCT.md). Be kind.

emodul-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+MIT License
+
+Copyright (c) 2026 Szymon Paluch
+
+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.
+
+---
+
+DISCLAIMER: This is an UNOFFICIAL third-party client. The author has no
+affiliation with TECH STEROWNIKI Sp. z o.o. or the eModul.pl service.
+"TECH", "Tech Sterowniki", "eModul" and related marks belong to their
+respective owners. This software is provided for personal use; using it
+to access services you do not own may violate those services' terms.