1.12.0 (#525)

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,62 @@
+name: Bug report
+description: Report an issue (a bug) with AsusRouter
+title: "[Bug] "
+labels: ["bug"]
+assignees:
+  - vaskivskyi
+body:
+  - type: markdown
+    attributes:
+      value: >
+        This form is for bug reports only (something does not work as expected) in AsusRouter Python library.
+        If you have a feature request or you would like to report some device as supported (meaning everything
+        works as expected), please, use the appropriate form.
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: The problem
+      description: >
+        Please, describe the issue. The more details you provide, the easier it would be to understand the issue.
+
+        Keep in mind, that the description should also be clear, so I will be able to help you with it.
+  - type: markdown
+    attributes:
+      value: >
+        # Environment and device
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Python version
+      description: >
+        Please, provide the version of Python you are using, e.g. `3.11.0`.
+  - type: input
+    id: device
+    validations:
+      required: true
+    attributes:
+      label: Your device model
+      description: >
+        Please, put in the full model of your device, e.g. `GT-AX11000 Pro`.
+      placeholder: RT-
+  - type: dropdown
+    id: firmware_type
+    validations:
+      required: true
+    attributes:
+      label: Firmware type
+      description: >
+        What kind of firmware you are using? Is it a stock AsusWRT or AsusWRT-Merlin?
+      options:
+        - Stock
+        - Merlin
+  - type: input
+    id: firmware_version
+    validations:
+      required: true
+    attributes:
+      label: Firmware version
+      description: >
+        Please, provide the full version of the firmware, e.g. `3.0.0.4.386.5_2` or `3.0.0.4.386_48631-g10d88e5`.
+      placeholder: 3.0.0.4.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/device_support.yml

@@ -0,0 +1,57 @@
+name: Supported device
+description: Report a device as supported (meaning everything works as expected)
+title: "[Supported device] "
+labels: ["documentation"]
+assignees:
+  - vaskivskyi
+body:
+  - type: markdown
+    attributes:
+      value: >
+        This form is for reporting devices as supported (meaning everything works as expected) in AsusRouter Python library.
+        If you have a bug report or you would like to request a feature, please, use the appropriate form.
+  - type: textarea
+    attributes:
+      label: Anything you want to mention?
+      description: >
+        Use this field for a short description if you would like.
+  - type: markdown
+    attributes:
+      value: >
+        # Environment and device
+  - type: input
+    validations:
+      required: true
+    attributes:
+      label: Python version
+      description: >
+        Please, provide the version of Python you are using, e.g. `3.11.0`.
+  - type: input
+    id: device
+    validations:
+      required: true
+    attributes:
+      label: Your device model
+      description: >
+        Please, put in the full model of your device, e.g. `GT-AX11000 Pro`.
+      placeholder: RT-
+  - type: dropdown
+    id: firmware_type
+    validations:
+      required: true
+    attributes:
+      label: Firmware type
+      description: >
+        What kind of firmware you are using? Is it a stock AsusWRT or AsusWRT-Merlin?
+      options:
+        - Stock
+        - Merlin
+  - type: input
+    id: firmware_version
+    validations:
+      required: true
+    attributes:
+      label: Firmware version
+      description: >
+        Please, provide the full version of the firmware, e.g. `3.0.0.4.386.5_2` or `3.0.0.4.386_48631-g10d88e5`.
+      placeholder: 3.0.0.4.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,36 @@
+name: Feature request
+description: Do you want a new feature for AsusRouter library?
+title: "[Feature] "
+labels: ["enhancement"]
+assignees:
+  - vaskivskyi
+body:
+  - type: markdown
+    attributes:
+      value: >
+        This form is for feature requests only (something new you would like to see) in AsusRouter Python library.
+        If you have a bug report or you would like to report some device as supported (meaning everything works as expected),
+        please, use the appropriate form.
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: The idea
+      description: >
+        Please, describe your idea. The more details you provide, the easier it would be to understand it.
+
+        How would this be useful?
+  - type: markdown
+    attributes:
+      value: >
+        # Environment and device
+  - type: dropdown
+    id: firmware_type
+    attributes:
+      label: Firmware type
+      description: >
+        Does this feature depend on the firmware type?
+      options:
+        - Any
+        - Stock
+        - Merlin

.github/workflows/ci.yml

@@ -24,10 +24,10 @@ jobs:
       pip_cache_dir: ${{ steps.pip-cache.outputs.dir }}
     steps:
       - name: Checkout
-        uses: actions/[email protected].5
+        uses: actions/[email protected].7
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/[email protected].0
+        uses: actions/[email protected].1
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -60,10 +60,10 @@ jobs:
         python-version: [3.11, 3.12]
     steps:
       - name: Checkout
-        uses: actions/[email protected].5
+        uses: actions/[email protected].7
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/[email protected].0
+        uses: actions/[email protected].1
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -92,7 +92,7 @@ jobs:
           pytest --cov=asusrouter --cov-report=xml:unit-tests-cov-${{ matrix.python-version }}.xml -k 'not test_devices'
 
       - name: Upload coverage to artifacts
-        uses: actions/[email protected].3
+        uses: actions/[email protected].6
         with:
           name: unit-tests-cov-${{ matrix.python-version }}
           path: unit-tests-cov-${{ matrix.python-version }}.xml
@@ -106,10 +106,10 @@ jobs:
         python-version: [3.11, 3.12]
     steps:
       - name: Checkout
-        uses: actions/[email protected].5
+        uses: actions/[email protected].7
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/[email protected].0
+        uses: actions/[email protected].1
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -138,7 +138,7 @@ jobs:
           pytest --cov=asusrouter --cov-report=xml:real-data-tests-cov-${{ matrix.python-version }}.xml tests/test_devices.py --log-cli-level=INFO
 
       - name: Upload coverage to artifacts
-        uses: actions/[email protected].3
+        uses: actions/[email protected].6
         with:
           name: real-data-tests-cov-${{ matrix.python-version }}
           path: real-data-tests-cov-${{ matrix.python-version }}.xml
@@ -152,22 +152,22 @@ jobs:
         python-version: [3.11, 3.12]
     steps:
       - name: Checkout
-        uses: actions/[email protected].5
+        uses: actions/[email protected].7
 
       - name: Download unit-tests coverage from artifacts
-        uses: actions/[email protected].7
+        uses: actions/[email protected].8
         with:
           name: unit-tests-cov-${{ matrix.python-version }}
           path: .
 
       - name: Download real-data-tests coverage from artifacts
-        uses: actions/[email protected].7
+        uses: actions/[email protected].8
         with:
           name: real-data-tests-cov-${{ matrix.python-version }}
           path: .
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4.4.1
+        uses: codecov/codecov-action@v4.5.0
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: true

.github/workflows/release.yml

@@ -14,12 +14,12 @@ jobs:
 
     steps:
     - name: Checkout the repository
-      uses: actions/[email protected].6
+      uses: actions/[email protected].7
       with:
         ref: ${{ github.event.release.target_commitish }}
 
     - name: Setup Python ${{ env.DEFAULT_PYTHON }}
-      uses: actions/[email protected].0
+      uses: actions/[email protected].1
       with:
         python-version: ${{ env.DEFAULT_PYTHON }}
 

.gitignore

@@ -5,13 +5,16 @@ __pycache__/
 dist/
 *.egg-info
 
+.python-version
+
 # Pytest
 .coverage
+pytest/
 
 ### Other
 # Test
 local_test*.py
 local/
 
 # VS Code
-.vscode
+.vscode