Metadata-Version: 2.1
Name: vicon-nexus-unity-stream-py
Version: 0.2
Summary: Python script to stream data from vicon nexus to unity
Home-page: https://pypi.org/project/vicon_nexus_unity_stream_py
License: MIT
Author: Ahmed Shariff
Author-email: shariff.mfa@outlook.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 1 - Planning
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: Flask-RESTful (>=0.3.9,<0.4.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: flask_restful (>=0.3.8,<0.4.0)
Requires-Dist: loguru (>=0.5.0,<0.6.0)
Requires-Dist: msgpack (>=1.0.4,<2.0.0)
Requires-Dist: pandas (>=1.5.1,<2.0.0)
Project-URL: Documentation, https://vicon_nexus_unity_stream_py.readthedocs.io
Project-URL: Repository, https://github.com/ahmed-shariff/vicon_nexus_unity_stream_py
Description-Content-Type: text/markdown

# Overview

Python script to stream data from vicon nexus to unity


# Setup

## Requirements

* Python 3.8+

## Installation

Install it directly into an activated virtual environment:

```text
$ pip install vicon_nexus_unity_stream_py
```

or add it to your [Poetry](https://poetry.eustace.io/) project:

```text
$ poetry add vicon_nexus_unity_stream_py
```

# Usage

After installation, the package can be used as a cli tool:

```text
$ vicon-nexus-stream --help

Usage: vicon-nexus-stream [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  server  Connects to the vicon and streams the data...
  stream  Instead of connecting to vicon, streams data...
  test    Test if connection is working
```


# Credits
This project was generated with [cookiecutter](https://github.com/audreyr/cookiecutter) using [jacebrowning/template-python](https://github.com/jacebrowning/template-python).

