1================================= 2 pySerial |build-status| |docs| 3================================= 4 5Overview 6======== 7This module encapsulates the access for the serial port. It provides backends 8for Python_ running on Windows, OSX, Linux, BSD (possibly any POSIX compliant 9system) and IronPython. The module named "serial" automatically selects the 10appropriate backend. 11 12- Project Homepage: https://github.com/pyserial/pyserial 13- Download Page: https://pypi.python.org/pypi/pyserial 14 15BSD license, (C) 2001-2020 Chris Liechti <cliechti@gmx.net> 16 17 18Documentation 19============= 20For API documentation, usage and examples see files in the "documentation" 21directory. The ".rst" files can be read in any text editor or being converted to 22HTML or PDF using Sphinx_. An HTML version is online at 23https://pythonhosted.org/pyserial/ 24 25Examples 26======== 27Examples and unit tests are in the directory examples_. 28 29 30Installation 31============ 32``pip install pyserial`` should work for most users. 33 34Detailed information can be found in `documentation/pyserial.rst`_. 35 36The usual setup.py for Python_ libraries is used for the source distribution. 37Windows installers are also available (see download link above). 38 39or 40 41To install this package with conda run: 42 43``conda install -c conda-forge pyserial`` 44 45conda builds are available for linux, mac and windows. 46 47.. _`documentation/pyserial.rst`: https://github.com/pyserial/pyserial/blob/master/documentation/pyserial.rst#installation 48.. _examples: https://github.com/pyserial/pyserial/blob/master/examples 49.. _Python: http://python.org/ 50.. _Sphinx: http://sphinx-doc.org/ 51.. |build-status| image:: https://travis-ci.org/pyserial/pyserial.svg?branch=master 52 :target: https://travis-ci.org/pyserial/pyserial 53 :alt: Build status 54.. |docs| image:: https://readthedocs.org/projects/pyserial/badge/?version=latest 55 :target: http://pyserial.readthedocs.io/ 56 :alt: Documentation 57
