Metadata-Version: 2.1
Name: scclib
Version: 0.1.1
Summary: Client library for S.C.I.L.E.R.
Home-page: https://github.com/IssaHanou/BEP_1920_Q2
Author: Raccoon Serious Games
Author-email: BEP@raccoon.games
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# scclib

## Client computer library for S.C.I.L.E.R. system
This mainly consists of:

- `scclib/scclib.py` the main file handling all communication with the rest of the system.
- `scclib/device.py` the superclass from which all client computer handlers should inherit. It defines the three main methods that need to be implemented.
- `scclib/device_test.py` the test file to test an implemented device script with.
- `device_manual.md` the manual for writing configuration files for devices
- `LICENSE.md` the license with which this library complies

## Set-up Device
- run `pip install -i https://test.pypi.org/simple/ scclib`
- create a custom device script, with a class inheriting from the Device superclass, whose main method is called in the script
- write configuration for the the device, according to device_manual.md, in the same folder as the script
- start broker for device to connect with
- run `python3 <custom-device>.py`

## License
This library is licensed with GNU GPL v3, see `LICENSE.md`.




