Metadata-Version: 2.0
Name: tinycom
Version: 1.1
Summary: A simple line based serial terminal GUI.
Home-page: https://github.com/digitalpeer/tinycom
Author: Joshua Henderson
Author-email: digitalpeer@digitalpeer.com
License: GPL3
Download-URL: https://github.com/digitalpeer/tinycom/zipball/master
Keywords: serial terminal
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Topic :: Terminals :: Serial
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology

TinyCom
=======

A simple line based serial terminal GUI written in Python. This is a
tool that's useful for talking to a variety of serial based hardware
that can involve custom protocols or just a standard command line
interface. It runs on anything that supports Python and Qt.

TinyCom is inspired by the original
`CuteCom <http://cutecom.sourceforge.net/>`__.

Features
--------

-  Line oriented input and output, with configurable line ending.
-  Customizeable serial port configuration.
-  Automatically enumerates platform serial ports.
-  History of input lines, to easily regenerate them with a click.
-  Log the session to a file.

Runtime Requirements
--------------------

This is just an overview of runtime requirements. All major versions of
both the Python interpreter and QT API are supported.

-  `Python2 or Python3 <https://www.python.org/>`__
-  `PyQt4 or
   PyQt5 <https://riverbankcomputing.com/software/pyqt/intro>`__ or
   `PySide <https://wiki.qt.io/PySide>`__
-  `Qt <https://www.qt.io/>`__
-  `pySerial <https://github.com/pyserial/pyserial>`__

Installation
------------

For simplicity, instructions for only PyQt4 and Python2 are listed here.
However, you can adjust to use any combination of Python2/Python3 and
PyQt4/PyQt5/Pyside if you prefer when it comes to runtime dependencies.

On Ubuntu, first install dependencies using the system package manager.

::

    sudo apt-get install python python-qt4 python-serial python-pip

Then, use pip to install tinycom.

::

    pip install [--user] tinycom

Or, if you're installing from source:

::

    pip install [--user] tinycom-<version>.tar.bz2

The --user option causes tinycom to be installed in your home directory
under ~/.local.

Then, if you somehow get fed up with TinyCom's awesomeness, uninstall
it.

::

    pip uninstall tinycom

Running
-------

Just execute ``tinycom``.

Screenshots
-----------

.. figure:: screenshots/main_window.png
   :alt: Main Window

   Main Window

PyQt4/PyQt5/PySide
------------------

TinyCom can use PyQt4, PyQt5, or PySide for its Qt API. As long as you
have one installed, it will be automatically detected and used at
runtime. However, if you wish to force a specific Qt API, you can set
the QT\_API environment variable to one of the following values when
running.

::

    QT_API=pyqt4 tinycom
    QT_API=pyqt5 tinycom
    QT_API=pyside tinycom

License
-------

TinyCom is licensed under GPL Version 3. See the ``LICENSE.txt`` file.
``qt.py`` is licensed under 3-clause BSD. ``pyside_dyanmic.py`` is MIT
licensed.


========================
TinyCom Release Notes
========================

Version 1.1     22 Feb 2017
---------------------------
- Ignore pylint wrong-import-position warning
- Convert README.md to rst long_description for PyPi
- Switch sdist to gztar by default
- Full support for PyQt4, PyQt5, and Pyside at runtime
- Remove dead code comment
- Enable universal package support by default


Version 1.0     20 Feb 2017
---------------------------
- Initial alpha release.


