-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update python for tests/pages and add poetry lockfile
- Loading branch information
1 parent
93be755
commit 42b97db
Showing
9 changed files
with
2,520 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -165,4 +165,3 @@ cython_debug/ | |
# application files | ||
/artifacts | ||
/db.sqlite3* | ||
/poetry.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,6 +2,11 @@ ci: | |
skip: | ||
- pytest | ||
repos: | ||
- repo: https://github.com/python-poetry/poetry | ||
rev: 1.8.4 | ||
hooks: | ||
- id: poetry-check | ||
- id: poetry-install | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v5.0.0 | ||
hooks: | ||
|
@@ -49,7 +54,7 @@ repos: | |
- id: biome-check | ||
additional_dependencies: ["@biomejs/[email protected]"] | ||
- repo: https://github.com/rbubley/mirrors-prettier | ||
rev: "v3.3.3" | ||
rev: "v3.4.0" | ||
hooks: | ||
- id: prettier | ||
files: \.(html|md|yml|yaml)$ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,21 +33,21 @@ A simplistic, opinionated remote update server implementing hawkBit™'s [DDI AP | |
|
||
Before running gooseBit for the first time, update the default credentials in `settings.yaml`. The default login for testing purposes is: | ||
|
||
- **Username:** `[email protected]` | ||
- **Password:** `admin` | ||
- **Username:** `[email protected]` | ||
- **Password:** `admin` | ||
|
||
## Assumptions | ||
|
||
- Devices use [SWUpdate](https://swupdate.org) for managing software updates. | ||
- Devices use [SWUpdate](https://swupdate.org) for managing software updates. | ||
|
||
## Features | ||
|
||
### Device Registry | ||
|
||
When a device connects to gooseBit for the first time, it is automatically added to the device registry. The server will then request the device's configuration data, including: | ||
- `hw_model` and `hw_revision`: Used to match compatible software. | ||
- `sw_version`: Indicates the currently installed software version. | ||
- `hw_model` and `hw_revision`: Used to match compatible software. | ||
- `sw_version`: Indicates the currently installed software version. | ||
The registry tracks each device's status, including the last online timestamp, installed software version, update state, and more. | ||
|
||
|
@@ -105,14 +105,14 @@ poetry run generate-sample-data | |
|
||
Code is formatted using different tools | ||
|
||
- black and isort for `*.py` | ||
- biomejs for `*.js`, `*.json` | ||
- prettier for `*.html`, `*.md`, `*.yml`, `*.yaml` | ||
- black and isort for `*.py` | ||
- biomejs for `*.js`, `*.json` | ||
- prettier for `*.html`, `*.md`, `*.yml`, `*.yaml` | ||
|
||
Code is linted using different tools as well | ||
|
||
- flake8 for `*.py` | ||
- biomejs for `*.js` | ||
- flake8 for `*.py` | ||
- biomejs for `*.js` | ||
|
||
Best to have pre-commit install git hooks that run all those tools before a commit: | ||
|
||
|
@@ -138,18 +138,18 @@ poetry run pytest | |
|
||
The structure of gooseBit is as follows: | ||
|
||
- `api`: Files for the API. | ||
- `ui`: Files for the UI. | ||
- `bff`: Backend for frontend API. | ||
- `static`: Static files. | ||
- `templates`: Jinja2 formatted templates. | ||
- `nav`: Navbar handler. | ||
- `updater`: DDI API handler and device update manager. | ||
- `updates`: SWUpdate file parsing. | ||
- `auth`: Authentication functions and permission handling. | ||
- `models`: Database models. | ||
- `db`: Database config and initialization. | ||
- `schema`: Pydantic models used for API type hinting. | ||
- `settings`: Settings loader and handler. | ||
- `telemetry`: Telemetry data handlers. | ||
- `routes`: Routes for a giving endpoint, including the router. | ||
- `api`: Files for the API. | ||
- `ui`: Files for the UI. | ||
- `bff`: Backend for frontend API. | ||
- `static`: Static files. | ||
- `templates`: Jinja2 formatted templates. | ||
- `nav`: Navbar handler. | ||
- `updater`: DDI API handler and device update manager. | ||
- `updates`: SWUpdate file parsing. | ||
- `auth`: Authentication functions and permission handling. | ||
- `models`: Database models. | ||
- `db`: Database config and initialization. | ||
- `schema`: Pydantic models used for API type hinting. | ||
- `settings`: Settings loader and handler. | ||
- `telemetry`: Telemetry data handlers. | ||
- `routes`: Routes for a giving endpoint, including the router. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,5 +20,5 @@ python main.py | |
|
||
Before running gooseBit for the first time, update the default credentials in `settings.yaml`. The default login for testing purposes is: | ||
|
||
- **Username:** `[email protected]` | ||
- **Password:** `admin` | ||
- **Username:** `[email protected]` | ||
- **Password:** `admin` |
Oops, something went wrong.