semvec/pypi-packages huggingface dataset:
LogToolKit 0.1.0
OBDSTAR log file decrypt toolkit
License: MIT
Requires Python: <4.0,>=3.12

## OBDSTAR log file toolkit

> [!CAUTION]
> For internal use only, circulation is prohibited

### Supported log types:

- ✅ std log version 6.000
- ✅ std log version 7.000
- ✅ diag request log

---

### FlowChart

```mermaid
flowchart TB
    LOG1[[std logs package]]
    LOG2[[diag request log]]

    DECRYPTER[log decrypter]
    PARSER{{log parser}}
    TASK1{{task1: ip geolocation}}
    TASK2{{task2: analyse log}}
    WEB1{{web: control panel}}
    ES[(ElasticSearch Cluster)]
    subgraph log processor
        LOG1 -->|in memory unzip| i11[log files] -->|log filter| DECRYPTER --> PARSER
        LOG2 -->|log spliter| PARSER
    end

    PARSER -- create --> ES
    ES -- read --> WEB1
    ES -- read --> TASK2
    ES <-- update --> TASK1
    WEB1 -- get analyse rule --> TASK2
    TASK2 -- trigger workfollow --> OA
```

---

### Usage

```bash
python -m logtoolkit --help
```

```bash
# build image
docker build . --tag obdstar-log-toolkit:latest

# run with args
docker run --rm \
    --volume $PWD/tests/data/diag_logs:/logs \
    obdstar-log-toolkit \
    process /logs/2024_03_18.txt
```

---

### Development CI

```bash
> make help
help          Display this help screen
init          Initialize project development environment
clean         Clean project files
format        Run project lint && format, auto fix
check         Run project lint && format check only, won't fix
test          Run pytest
build         Build project
docker-build  Build docker image
update-ipgeo  Update ip geolocation database
```