updated README
This commit is contained in:
41
README.md
41
README.md
@@ -6,6 +6,29 @@
|
|||||||
|
|
||||||
Needs a long-lived token for HA in `secrets.yaml`
|
Needs a long-lived token for HA in `secrets.yaml`
|
||||||
|
|
||||||
|
### Debugger
|
||||||
|
|
||||||
|
Use with VSCode's debugger using a `launch.json` file.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
// Use IntelliSense to learn about possible attributes.
|
||||||
|
// Hover to view descriptions of existing attributes.
|
||||||
|
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"name": "AppDaemon Dev",
|
||||||
|
"type": "debugpy",
|
||||||
|
"request": "launch",
|
||||||
|
"module": "appdaemon",
|
||||||
|
"justMyCode": true,
|
||||||
|
"args": "-c ../conf"
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Test Script
|
### Test Script
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -20,22 +43,22 @@ cd $REPO_DIR
|
|||||||
|
|
||||||
rm -rf ./dist
|
rm -rf ./dist
|
||||||
|
|
||||||
|
# isort ./appdaemon ./docs/conf.py
|
||||||
|
|
||||||
|
black ./appdaemon ./docs/conf.py
|
||||||
|
|
||||||
|
pre-commit run --all-files
|
||||||
|
|
||||||
|
python -m pytest
|
||||||
|
|
||||||
python -m build
|
python -m build
|
||||||
|
|
||||||
docker build -t appdaemon:jsl-dev .
|
docker build -t appdaemon:local-dev .
|
||||||
|
|
||||||
cd ../conf
|
cd ../conf
|
||||||
docker compose run -it --rm appdaemon
|
docker compose run -it --rm appdaemon
|
||||||
```
|
```
|
||||||
|
|
||||||
## TODO
|
|
||||||
|
|
||||||
### Reloading
|
|
||||||
|
|
||||||
- Seems to work from non-package module
|
|
||||||
- Does not work from inside a package module
|
|
||||||
|
|
||||||
|
|
||||||
## Reference
|
## Reference
|
||||||
|
|
||||||
- [`importlib.reload(module)`](https://docs.python.org/3/library/importlib.html#importlib.reload)
|
- [`importlib.reload(module)`](https://docs.python.org/3/library/importlib.html#importlib.reload)
|
||||||
|
|||||||
Reference in New Issue
Block a user