From daed2ec12f5d338a25ecbb34901bff713ff948a1 Mon Sep 17 00:00:00 2001 From: Tom Scholten Date: Sat, 2 Aug 2025 23:25:10 +0200 Subject: [PATCH] Small adjustments --- .github/workflows/verify.yml | 2 +- .markdownlint.yaml | 2 ++ README.md | 4 +++- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/.github/workflows/verify.yml b/.github/workflows/verify.yml index 3794cdd..879ff42 100644 --- a/.github/workflows/verify.yml +++ b/.github/workflows/verify.yml @@ -73,7 +73,7 @@ jobs: - name: Full pre-commit run: | . venv/bin/activate - pre-commit run --show-diff-on-failure --color=always --all-files + SKIP=no-commit-to-branch pre-commit run --show-diff-on-failure --color=always --all-files pytest: runs-on: ubuntu-latest diff --git a/.markdownlint.yaml b/.markdownlint.yaml index e01484b..c5006e5 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,3 +1,5 @@ default: true MD013: false MD024: false +MD033: false +MD041: false diff --git a/README.md b/README.md index 3e8a579..7025afc 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=CoMPaTech_python-airos&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=CoMPaTech_python-airos) # Overview + `python-airos` or [`airos`](https://pypi.org/projects/airos) from pypi is an asynchronous Python library designed to programmatically interact with Ubiquiti airOS devices. It mimics a web browser client to fetch device status, configuration, and perform actions like kicking connected stations. This library is a key component for a potential future core integration with [Home Assistant](https://www.home-assistant.io), with the initial pull request for core integration targeted for the 2025.8 release. @@ -116,9 +117,10 @@ The library currently supports the following methods: - `login()`: Authenticates with the device. - `status()`: Fetches a comprehensive dictionary of the device's status and statistics. --` stakick(mac_address)`: Disconnects a specific station by its MAC address. +- `stakick(mac_address)`: Disconnects a specific station by its MAC address. More features and API calls are planned for future releases. ## Contributing + We welcome contributions as well as additional codeowners to python-airos.