Metadata-Version: 2.4
Name: sockcan
Version: 0.5.2
Summary: Provides a socketcan-alike interface other arbitrary CAN drivers
Project-URL: Homepage, https://github.com/Hedwyn/sockcan
Author: Baptiste Pestourie
Requires-Python: >=3.12
Provides-Extra: daemon
Requires-Dist: click; extra == 'daemon'
Requires-Dist: python-can; extra == 'daemon'
Provides-Extra: docs
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Provides-Extra: test
Requires-Dist: hypothesis; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: python-can; extra == 'test'
Description-Content-Type: text/markdown

# sockcan

Provides a socketcan-alike interface other arbitrary CAN drivers.

## Installing

```
pip install sockcan
```

## Documentation

Documentation is available [here](https://Hedwyn.github.io/sockcan/).

## Running benchmarks

Benchmarks can be run with `python -m sockcan.benchmarks`:

```shell
python -m sockcan.benchmarks --help
Usage: python -m sockcan.benchmarks [OPTIONS]

  Runs the benchmarks interactively

Options:
  -r, --rounds INTEGER
  -b, --batch-size INTEGER
  -v, --verbose
  --help                    Show this message and exit.
```

## Running tests

Tests are based on `pytest` and `hypothesis`. Make sure to install this package with `test` extra (`pip install .\[test\`).<br>
You can show hypothesis stats with `--hypothesis-show-statistics`:

```shell
python -m pytest -vv --hypothesis-show-statistics
```
