luxos 0.0.0.0__tar.gz

luxos-0.0.0.0/.github/pull_request_template.md

@@ -0,0 +1,12 @@
+## Description
+
+Add your description here.
+
+## Merge request checklist
+
+- [ ] Added the appropriate `bug`, `enhancement` and/or `breaking-change` tags
+- [ ] My code passes all tests, linter and formatting checks (`make check`).
+- [ ] My commits follow the [How to Write a Git Commit Message Guide](https://chris.beams.io/posts/git-commit/).
+- [ ] I have updated the `CHANGELOG` (yeah, last chance to do it).
+- [ ] Run the `python make.py onepack` and add the new luxos.pyz/health-checker.pyz 
+     generated files

luxos-0.0.0.0/.github/workflows/pull-python-luxos.yml

@@ -0,0 +1,86 @@
+name: LuxOS Pull-Request
+
+on:
+  pull_request:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+env:
+  PACKAGE: luxos
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Set up runner 
+        run: echo noop
+
+      - name: Checkout
+        uses: actions/checkout@v4.1.0
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Setup Python toolchain
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Python dependencies
+        shell: bash
+        run: |
+            python -m pip install --upgrade pip
+            pip install -r tests/requirements.txt
+
+      - name: Run Python checks (ruff)
+        shell: bash
+        env:
+          PYTHONPATH: src
+        run: |
+           ruff check src tests
+
+      - name: Run Python checks (mypy)
+        shell: bash
+        env:
+          PYTHONPATH: src
+          OUTDIR: build/qa-${{ matrix.python-version }}-${{ matrix.os}}
+        run: |
+          mypy src \
+            --no-incremental --xslt-html-report $OUTDIR/mypy
+
+      - name: Run Python checks
+        shell: bash
+        env:
+          PYTHONPATH: src
+          OUTDIR: build/qa-${{ matrix.python-version }}-${{ matrix.os}}
+        run: |
+          py.test \
+              --cov=${{ env.PACKAGE }} \
+              --cov-report=html:$OUTDIR/coverage --cov-report=xml:$OUTDIR/coverage.xml \
+              --junitxml=$OUTDIR/junit/junit.xml --html=$OUTDIR/junit/junit.html --self-contained-html \
+            tests
+
+      - name: Build wheel packages
+        if: ${{ ! contains(matrix.os, 'windows') }}
+        env:
+          GITHUB_DUMP: ${{ toJson(github) }}
+        run: |
+          python -m build
+          touch .keepme
+
+      - name: Archive artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: qa-results-${{ matrix.python-version }}-${{ matrix.os }}
+          path: |
+            build/qa-${{ matrix.python-version }}-${{ matrix.os}}
+            dist
+            .keepme
+        # Use always() to always run this step to publish test results when there are test failures
+        if: always()

luxos-0.0.0.0/.github/workflows/push-main.yml

@@ -0,0 +1,88 @@
+name: Master build
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+env:
+  PACKAGE: luxos
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Set up runner 
+        run: echo noop
+
+      - name: Checkout
+        uses: actions/checkout@v4.1.0
+        with:
+          ref: ${{ github.event.push.ref }}
+
+      - name: Setup Python toolchain
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Python dependencies
+        shell: bash
+        run: |
+            python -m pip install --upgrade pip
+            pip install -r tests/requirements.txt
+
+      - name: Run Python checks (ruff)
+        shell: bash
+        env:
+          PYTHONPATH: src
+        run: |
+           ruff check src tests
+
+      - name: Run Python checks (mypy)
+        shell: bash
+        env:
+          PYTHONPATH: src
+          OUTDIR: build/qa-${{ matrix.python-version }}-${{ matrix.os}}
+        run: |
+          mypy src \
+            --no-incremental --xslt-html-report $OUTDIR/mypy
+
+      - name: Run Python checks
+        shell: bash
+        env:
+          PYTHONPATH: src
+          OUTDIR: build/qa-${{ matrix.python-version }}-${{ matrix.os}}
+        run: |
+          py.test \
+              --cov=${{ env.PACKAGE }} \
+              --cov-report=html:$OUTDIR/coverage --cov-report=xml:$OUTDIR/coverage.xml \
+              --junitxml=$OUTDIR/junit/junit.xml --html=$OUTDIR/junit/junit.html --self-contained-html \
+            tests
+
+      - name: Build wheel packages
+        if: ${{ ! contains(matrix.os, 'windows') }}
+        env:
+          GITHUB_DUMP: ${{ toJson(github) }}
+        run: |
+          python -m build
+          touch .keepme
+
+      - name: Archive artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: qa-results-${{ matrix.python-version }}-${{ matrix.os }}
+          path: |
+            build/qa-${{ matrix.python-version }}-${{ matrix.os}}
+            dist
+            .keepme
+        # Use always() to always run this step to publish test results when there are test failures
+        if: always()

luxos-0.0.0.0/.gitignore

@@ -0,0 +1,37 @@
+/myenv
+/build
+/dist
+
+
+# Compiled Python files
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+
+# Python virtual environment
+venv/
+env/
+*.env
+
+# System, editor and IDE files
+.vscode
+.work
+.ci-cargo
+.idea/
+*.swp
+*.swo
+*~
+.project
+*.pyproj
+.DS_Store
+Thumbs.db
+
+# Ignore common temporary files
+*.log
+*.csv
+tmp/
+*.tmp
+
+# Sonar artifacts
+clippy.log

luxos-0.0.0.0/.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+#  - repo: https://github.com/astral-sh/ruff-pre-commit
+#    rev: v0.3.4
+#    hooks:
+#    - id: ruff
+#      args: [--fix, --exit-non-zero-on-fix]
+#
+#  - repo: https://github.com/pre-commit/mirrors-mypy
+#    rev: v1.9.0
+#    hooks:
+#    -   id: mypy
+#        exclude: ^(tests)
+
+repos:
+  - repo: local
+    hooks:
+      # repo: https://github.com/astral-sh/ruff-pre-commit
+      - id: ruff
+        name: ruff
+        description: "Run 'ruff' for extremely fast Python linting"
+        entry: ruff check --force-exclude
+        language: system
+        types_or: [python, pyi]
+        args: []
+        require_serial: true
+        additional_dependencies: []
+        minimum_pre_commit_version: "2.9.2"
+
+      - id: ruff-format
+        name: ruff-format
+        description: "Run 'ruff format' for extremely fast Python formatting"
+        entry: ruff format --force-exclude
+        language: system
+        types_or: [python, pyi]
+        args: []
+        require_serial: true
+        additional_dependencies: []
+        minimum_pre_commit_version: "2.9.2"
+
+      # https://github.com/pre-commit/mirrors-mypy
+      - id: mypy
+        name: mypy
+        description: ''
+        entry: mypy
+        language: system
+        types_or: [python, pyi]
+        args: ["--ignore-missing-imports", "--scripts-are-modules"]
+        require_serial: true
+        additional_dependencies: []
+        minimum_pre_commit_version: '2.9.2'

luxos-0.0.0.0/CHANGELOG.md

@@ -0,0 +1,11 @@
+# LUXOS CHANGELOG
+
+All notable changes to this project will be documented in this file.
+<!--
+Please, use the format:
+
+## [Unreleased]
+
+ - <module>: short description
+
+-->

luxos-0.0.0.0/DEVELOP.md

@@ -0,0 +1,82 @@
+# Develop
+
+These are the developer's note, to develop luxos.
+
+> **NOTE** We assume we're working inside the checked out
+> `firmware-biz-tools` directory, and you have python (>=3.10)
+> in your path.
+
+## Setup
+
+These instructions are useful for a quick start, and
+you should be able to:
+
+- **SETUP** the environment (this is done once)
+  <details><summary>Windows</summary>
+
+  ```shell
+  python -m venv myenv
+  .\myenv\Scripts\activate  
+
+  pip install -r tests\requirements.txt
+  pip install -e .
+  ```
+  </details>
+  
+  <details><summary>*NIX</summary>
+  
+  ```shell
+  python -m venv myenv  
+  source ./myenv/bin/activate
+  
+  pip install -r tests\requirements.txt
+  pip install -e .
+  ```
+  
+- **ACTIVATE** the environment (each time you start a new shell)
+  <details><summary>Windows</summary>
+
+  ```shell
+  .\myenv\Scripts\activate
+  ```
+  </details>
+  <details><summary>*NIX</summary>
+
+  ```shell
+  source ./myenv/bin/activate
+  ```
+  </details>
+  
+- **RUN** the tests
+  
+  (Windows & *NIX)
+  ```shell
+  pytest -vvs tests
+  ```
+
+## Coding
+
+### Precommit
+When it comes to coding, you can use [pre-commit](https://pre-commit.com/) hooks
+to help you validate code at every git commit.
+
+- **ENABLE** precommit:
+  ```shell
+  pre-commit install
+  ```
+
+- **DISABLE** precommit:
+  ```shell
+  pre-commit uninstall
+  ```
+
+- **SKIP CHECKS** during git commit:
+  Use the `-n` flag:
+  ```shell
+  git commit -n ....
+  ```
+
+
+
+At every `git commit` code scanner [ruff](https://github.com/astral-sh/ruff) and
+[mypy](https://mypy-lang.org) will run.

luxos-0.0.0.0/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.3
+Name: luxos
+Version: 0.0.0.0
+Summary: The all encompassing LuxOS python library.
+Project-URL: Source, https://github.com/LuxorLabs/firmware-biz-tools
+Project-URL: Issues, https://github.com/LuxorLabs/firmware-biz-tools/issues
+Author-email: Antonio Cavallo <antonio.cavallo@luxor.tech>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Requires-Dist: asyncpg
+Requires-Dist: httpx
+Requires-Dist: pandas
+Requires-Dist: pyyaml
+Requires-Dist: tqdm
+Description-Content-Type: text/markdown
+
+# LuxOS Tools Repository
+
+> **WARNING** There are references into the PR luxos-code-refactoring
+
+This repository contains scripts we built to operate and troubleshoot miners running LuxOS.
+
+## Install
+
+There are few ways to install the luxos package:
+
+1. Using pip (suggested for end-users):
+   ```shell
+   pip install luxos
+   pip install git+https://github.com/LuxorLabs/luxos-tooling.git@pr/luxos-code-refactoring  
+   ```
+   Using pip gives you access to the cli commands `luxos` and `health-checker` as well
+   the ability to import in python the `import luxos.api` api for luxos.
+
+2. A single drop in file (for support):
+   ```shell
+   curl -LO https://github.com/LuxorLabs/luxos-tooling/raw/pr/luxos-code-refactoring/luxos.pyz
+   ```
+   These are two standalone [zipapp](https://docs.python.org/3/library/zipapp.html) files, you can use
+   from the command line as `python luxos.pyz`, no dependencies beside a recent-*ish* python
+   version (eg. >= 3.10)
+
+3. From the [github](https://github.com/LuxorLabs/luxos-tooling) source checkout (for devs):
+   ```shell
+   python -m venv venv 
+   source venv/bin/activate # for Windows: .\myenv\Scripts\activate)
+
+   pip install -r tests/requirements.txt
+   
+   export PYTHONPATH=$(pwd)/src # for Windows: SET PYTHONPATH=%CD%\src
+   (or)
+   pip install -e .
+   ```
+
+## LuxOS API Wrapper - luxos
+
+This tool offers a convenient way to interact with LuxOS through a command-line interface (CLI) or as Python packages for more advanced integrations.
+
+**CLI Usage**
+
+The luxos.py script serves as a versatile LuxOS API wrapper, allowing users to interact with LuxOS features directly from the command line. Below are some basic examples:
+
+```bash
+python3 -m luxos --ipfile miners.csv --cmd rebootdevice --timeout 2
+python3 -m luxos --range_start 192.168.1.0 --range_end 192.168.1.255 --cmd rebootdevice --verbose True
+```
+
+> **NOTE** Please don't forget to set the PYTHONPATH.
+
+**Library Usage**
+
+If you prefer to integrate LuxOS functionality into your Python applications or scripts, luxos.py can also be used as a Python package. Here's a quick example:
+
+```python
+from luxos.api import (execute_command)
+
+execute_command("192.168.1.1", 4028, 2, "rebootdevice", "", False)
+```
+
+## LuxOS HealthChecker - health_checker.py
+
+The HealthChecker script is designed to continuously pull miner data from LuxOS, providing valuable insights into the health of your mining machines.
+
+You can customize the HealthChecker params using the `config.yaml` file provided. 
+To run the HealthChecker you can use `health-checker` if you installed using pip, or
+the cli `python3 -m luxos.scripts.health_checker`.
+
+---
+
+Feel free to explore and customize these tools to suit your specific needs. 
+If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request.
+
+You can find LuxOS API documentation [here](https://docs.luxor.tech/firmware/api/intro).

luxos-0.0.0.0/README.md

@@ -0,0 +1,77 @@
+# LuxOS Tools Repository
+
+> **WARNING** There are references into the PR luxos-code-refactoring
+
+This repository contains scripts we built to operate and troubleshoot miners running LuxOS.
+
+## Install
+
+There are few ways to install the luxos package:
+
+1. Using pip (suggested for end-users):
+   ```shell
+   pip install luxos
+   pip install git+https://github.com/LuxorLabs/luxos-tooling.git@pr/luxos-code-refactoring  
+   ```
+   Using pip gives you access to the cli commands `luxos` and `health-checker` as well
+   the ability to import in python the `import luxos.api` api for luxos.
+
+2. A single drop in file (for support):
+   ```shell
+   curl -LO https://github.com/LuxorLabs/luxos-tooling/raw/pr/luxos-code-refactoring/luxos.pyz
+   ```
+   These are two standalone [zipapp](https://docs.python.org/3/library/zipapp.html) files, you can use
+   from the command line as `python luxos.pyz`, no dependencies beside a recent-*ish* python
+   version (eg. >= 3.10)
+
+3. From the [github](https://github.com/LuxorLabs/luxos-tooling) source checkout (for devs):
+   ```shell
+   python -m venv venv 
+   source venv/bin/activate # for Windows: .\myenv\Scripts\activate)
+
+   pip install -r tests/requirements.txt
+   
+   export PYTHONPATH=$(pwd)/src # for Windows: SET PYTHONPATH=%CD%\src
+   (or)
+   pip install -e .
+   ```
+
+## LuxOS API Wrapper - luxos
+
+This tool offers a convenient way to interact with LuxOS through a command-line interface (CLI) or as Python packages for more advanced integrations.
+
+**CLI Usage**
+
+The luxos.py script serves as a versatile LuxOS API wrapper, allowing users to interact with LuxOS features directly from the command line. Below are some basic examples:
+
+```bash
+python3 -m luxos --ipfile miners.csv --cmd rebootdevice --timeout 2
+python3 -m luxos --range_start 192.168.1.0 --range_end 192.168.1.255 --cmd rebootdevice --verbose True
+```
+
+> **NOTE** Please don't forget to set the PYTHONPATH.
+
+**Library Usage**
+
+If you prefer to integrate LuxOS functionality into your Python applications or scripts, luxos.py can also be used as a Python package. Here's a quick example:
+
+```python
+from luxos.api import (execute_command)
+
+execute_command("192.168.1.1", 4028, 2, "rebootdevice", "", False)
+```
+
+## LuxOS HealthChecker - health_checker.py
+
+The HealthChecker script is designed to continuously pull miner data from LuxOS, providing valuable insights into the health of your mining machines.
+
+You can customize the HealthChecker params using the `config.yaml` file provided. 
+To run the HealthChecker you can use `health-checker` if you installed using pip, or
+the cli `python3 -m luxos.scripts.health_checker`.
+
+---
+
+Feel free to explore and customize these tools to suit your specific needs. 
+If you encounter any issues or have suggestions for improvement, please open an issue or submit a pull request.
+
+You can find LuxOS API documentation [here](https://docs.luxor.tech/firmware/api/intro).

luxos-0.0.0.0/config.yaml

@@ -0,0 +1,54 @@
+output:
+  verbose: false # Logging verbose output
+  csv_output: healthcheck.csv # File name for the health check results
+  local_grafana_file: health_checks/local_grafana.csv # Local file where outputs will be stored to support local Grafana operation
+  report_output_type: csv # Output type (csv or db)
+
+# File containing IP addresses for scanning
+ipfile: miners.csv
+
+# IP range for scanning (leave null if using csv file for scan)
+ip_settings:
+  range_start: null # IP start range
+  range_end: null # IP end range
+
+threads:
+  max_threads: 10 # Maximum number of threads to use (watch out so we dont overload the network)
+
+luxos:
+  port: 4028 # Port for LuxOS API
+  timeout: 5 # Timeout for network scan in seconds
+
+# Time (in seconds) to wait between each execution of the health check (to start the loop again)
+sleep_between_executions: 10
+
+# Database settings (if report_output_type is db)
+database:
+  host: ""
+  port:
+  name:
+  user:
+  password:
+  table_name:
+
+# Configuration execution settings
+execution:
+  executeconfigs: "False" # Define if configs should be executed on miners after every health check
+  tempctrlset:
+    execute: "True" # Execute tempctrlset
+    param1: 50
+    param2: 66
+    param3: 76
+  atmset:
+    execute: "False" # Execute atmset
+    param1: enabled=true
+    param2: startup_minutes=1
+    param3: post_ramp_minutes=1
+    param4: temp_window=3
+  fanset:
+    execute: "True" # Execute fanset
+    param1: 100
+    param2: 3
+  immersionswitch:
+    execute: "False" # Execute immersionswitch
+    param1: off