Make device initialisation easier by reducing required imports (#936)

Adds username and password arguments to discovery to remove the need to import Credentials.
Creates TypeAliases in Device for connection configuration classes and DeviceType.
Using the API with these changes will only require importing either Discover or Device
depending on whether using Discover.discover() or Device.connect() to 
initialize and interact with the API.
This commit is contained in:
Steven B
2024-06-03 21:06:54 +03:00
committed by GitHub
parent bfba7a347f
commit be5202ccb7
12 changed files with 263 additions and 90 deletions

View File

@@ -6,12 +6,14 @@ This page contains guides of how to perform common actions using the library.
```{eval-rst}
.. automodule:: kasa.discover
:noindex:
```
## Connect without discovery
```{eval-rst}
.. automodule:: kasa.deviceconfig
:noindex:
```
## Get Energy Consumption and Usage Statistics

View File

@@ -1,10 +1,11 @@
# API Reference
```{currentmodule} kasa
```
## Discover
```{module} kasa.discover
```
```{eval-rst}
.. autoclass:: kasa.Discover
:members:
@@ -12,8 +13,51 @@
## Device
```{module} kasa.device
```
```{eval-rst}
.. autoclass:: kasa.Device
.. autoclass:: Device
:members:
:undoc-members:
```
## Device Config
```{module} kasa.credentials
```
```{eval-rst}
.. autoclass:: Credentials
:members:
:undoc-members:
```
```{module} kasa.deviceconfig
```
```{eval-rst}
.. autoclass:: DeviceConfig
:members:
:undoc-members:
```
```{eval-rst}
.. autoclass:: kasa.DeviceFamily
:members:
:undoc-members:
```
```{eval-rst}
.. autoclass:: kasa.DeviceConnection
:members:
:undoc-members:
```
```{eval-rst}
.. autoclass:: kasa.DeviceEncryption
:members:
:undoc-members:
```