Metadata-Version: 2.3
Name: PyDevDTK
Version: 0.1.1
Summary: Python device development toolkit
Project-URL: Homepage, https://github.com/BojanSof/pydevdtk
Project-URL: Bug Tracker, https://github.com/BojanSof/pydevdtk/issues
Author-email: Bojan Sofronievski <bojan.drago@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: matplotlib>=3.5.2
Requires-Dist: numpy>=1.23.3
Description-Content-Type: text/x-rst

.. image:: https://raw.githubusercontent.com/BojanSof/PyDevDTK/main/images/icon.png
    :align: center
    :width: 256

PyDevDTK
========

Python package that provides basic tools for device development, including:

Communication protocols:

    - UART
    - BLE

Real-time visualizations, which can be fully customized, or use one of the following plots:

    - Line plots
    - Scatter plots
    - Bar plots
    - Image plots

More communication protocols and plots are added iteratively.

Installing
----------

The repository includes GitHub actions which publish the package to PyPI and TestPyPI. To install the latest release package, run:

.. code-block:: shell

    pip install pydevdtk

To install the latest development package, which is published on TestPyPI, run:

.. code-block:: shell

    pip install --index-url https://test.pypi.org/simple pydevdtk

If you need to install the package locally for development, run the following command in the root of the repository:

.. code-block:: shell

    pip install -e .

Requirements
------------

Requirements can be found under ``requirements`` directory, which includes:

- ``default.txt`` - base requirements for the package
- ``build.txt`` - requirements for building the package
- ``doc.txt`` - requirements for building the documentation (WIP)
- ``dev.txt`` - requirements for developing the package, including linters and formatters
