Usage

Installation

To use tiny_interface, first install it using pip (TBD):

(.venv) $ pip install tiny_interface

The above python package installation is TBD. For now, you can install the package by cloning the repository and running the following command from the root directory of the repository:

This tool uses Python, Django, SQLite3, pyyaml for database management. While pyyaml is included in the package installation, sqlite3 is not, as it is not directly available in Windows through pip. SQLite3 can be installed from [official website](https://www.sqlite.org/download.html).

To install dependencies, it is recommended to first create a virtual environment. To create a virtual environment, run the following command:

(.venv) $ python3 -m venv <path/to/new/virtual/environment>

To activate the virtual environment, run the following command (in Linux or MacOS):

(.venv) $ source <path/to/new/virtual/environment>/bin/activate

In Windows, run the following command:

<path/to/new/virtual/environment>/Scripts/activate

To deactivate the virtual environment, run the following command:

deactivate

A requirements.txt file is provided in the repository. To install the dependencies, run the following command:

pip install -r requirements.txt

Verify Django installation by going into python terminal:

>>> import django
>>> print(django.get_version())

SQLite3 is not directly available through pip. Install SQLite3 from [official website](https://www.sqlite.org/download.html) for viewing the data tables.

Creating interface signal database

To create a database of interface signals, use the signalManager.create_database() function.

For example:

>>> from tiny_interface import signalManager
>>> mgr = signalManager()
>>> mgr.create_database()