Metadata-Version: 2.1
Name: opendis
Version: 1.0
Summary: implementation of DIS, IEEE-1278.1
Home-page: https://github.com/open-dis/open-dis-python
Author: Don McGregor
Author-email: mcgredo@nps.edu
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
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: Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator
Requires-Dist: numpy (>=1.26.4,<2.0.0)
Project-URL: Documentation, https://open-dis.org/
Project-URL: Repository, https://github.com/open-dis/open-dis-python
Description-Content-Type: text/markdown

## open-dis-python

[![Build Status](https://app.travis-ci.com/open-dis/open-dis-python.svg?branch=master)](https://app.travis-ci.com/open-dis/open-dis-python)
[![PyPI Version](https://shields.mitmproxy.org/pypi/v/opendis.svg)](https://pypi.org/project/opendis/)

A Python 3 implementation of the Distributed Interactive Simulation (DIS) 7 standard.
Initially generated by [xmlpg](https://github.com/open-dis/xmlpg).

## Library installation

From source:

```bash
pip install .
```

For developers of this library (This installs a symlink to the sources so they can be edited and referenced in `tests` and `examples` without a reinstall):
```bash
pip install -e .
```

## Run examples

Run a receiver:

```bash
cd examples
python3 dis_receiver.py
```

In another terminal, run the sender:

```bash
python3 dis_sender.py
```

You should also see the traffic on the net in Wireshark on your localhost interface.

Press `Ctrl+\` to stop the process.

## Documentation

You can auto generate API docs from the project source code:
```bash
pip install pdoc
pdoc --html --html-dir docs opendis
```

The docs will be generated in the `docs/opendis` folder.

## Poetry setup
1. `poetry install` or `poetry update`
1. `poetry run python examples/dis_receiver.py` or `poetry shell` && `python examples/dis_receiver.py`

