Metadata-Version: 2.4
Name: can-log-analyzer
Version: 26.0.2
Summary: CAN log Analyzer
Project-URL: homepage, https://github.com/auto-py-utils/can-log-analyzer
Project-URL: repository, https://github.com/auto-py-utils/can-log-analyzer/
Project-URL: documentation, https://auto-py-utils.github.io/can-log-analyzer
Author-email: auto-py-utils <chaitu.ycr@gmail.com>
License: MIT License
        
        Copyright (c) 2026 auto-py-utils
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: CAN,analyzer,log,python
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: cantools
Requires-Dist: matplotlib
Requires-Dist: nicegui[native]
Requires-Dist: pandas
Requires-Dist: plotly
Requires-Dist: pyarrow
Requires-Dist: python-can
Description-Content-Type: text/markdown

# CAN Log Analyzer

A web-based tool for analyzing CAN log files using NiceGui, Plotly, and cantools.

![CAN Log Analyzer UI](https://raw.githubusercontent.com/auto-py-utils/can-log-analyzer/main/docs/_assets/can_log_analyzer_ui.png)

## Features

- Upload and parse CAN log files (`.asc`, `.blf`)
- Load CAN database files (`.dbc`)
- Visualize and plot selected CAN signals interactively
- User-friendly web interface with sidebar controls
- Interactive signal selection and customizable plots (scatter, line, heatmap)
- Grid and axis customization for detailed analysis

## Notes

- Ensure you are using Python >= 3.10 as specified in the project requirements.
- Only `.dbc` files are supported for CAN database input.

## Usage - Web App

The application can be launched in any of these ways:

```bash
python -m can_log_analyzer
```

```bash
can-log-analyzer
```

```bash
uv run can-log-analyzer
```

- The app will launch in your default web browser at `http://localhost:8080` by default.
- Use the sidebar to upload your CAN log files (`.asc`, `.blf`) and CAN database files (`.dbc`).
- Select channels, messages, and signals to visualize.
- Choose plot type and customize grid/axis options as needed.
- Interactive plots and analysis will be available after loading your files.

## Usage - Development Scripts

The repository includes OS-specific wrappers under `scripts/` for common workflows.

Linux:

```bash
./scripts/venv_setup.sh
./scripts/build_wheel_package.sh
./scripts/run_pytests_with_report.sh
./scripts/deploy_docs_to_github.sh
```

Windows:

```powershell
scripts\venv_setup.bat
scripts\build_wheel_package.bat
scripts\run_pytests_with_report.bat
scripts\deploy_docs_to_github.bat
```

Both sets of scripts install `uv` if missing, sync dependencies with `uv sync --link-mode=copy`, and then execute the requested task.

## [source manual](https://auto-py-utils.github.io/can-log-analyzer/source-manual/)
