| Chris Liechti | 388faab | 2015-09-15 00:42:43 +0200 | [diff] [blame] | 1 | ================================= |
| 2 | pySerial |build-status| |docs| |
| 3 | ================================= |
| cliechti | 10d58b2 | 2009-07-30 23:15:25 +0000 | [diff] [blame] | 4 | |
| 5 | Overview |
| cliechti | 980e4b0 | 2005-12-20 23:19:58 +0000 | [diff] [blame] | 6 | ======== |
| cliechti | 949e15d | 2009-02-07 00:24:03 +0000 | [diff] [blame] | 7 | This module encapsulates the access for the serial port. It provides backends |
| Chris Liechti | 418262d | 2015-10-01 23:25:17 +0200 | [diff] [blame] | 8 | for Python_ running on Windows, OSX, Linux, BSD (possibly any POSIX compliant |
| 9 | system) and IronPython. The module named "serial" automatically selects the |
| 10 | appropriate backend. |
| cliechti | 89b4af1 | 2002-02-12 23:24:41 +0000 | [diff] [blame] | 11 | |
| Chris Liechti | 80e2ae2 | 2015-08-04 02:59:50 +0200 | [diff] [blame] | 12 | - Project Homepage: https://github.com/pyserial/pyserial |
| 13 | - Download Page: https://pypi.python.org/pypi/pyserial |
| cliechti | 89b4af1 | 2002-02-12 23:24:41 +0000 | [diff] [blame] | 14 | |
| Chris Liechti | 6fa82e1 | 2020-09-21 00:44:45 +0200 | [diff] [blame] | 15 | BSD license, (C) 2001-2020 Chris Liechti <cliechti@gmx.net> |
| cliechti | 89b4af1 | 2002-02-12 23:24:41 +0000 | [diff] [blame] | 16 | |
| 17 | |
| cliechti | 10d58b2 | 2009-07-30 23:15:25 +0000 | [diff] [blame] | 18 | Documentation |
| 19 | ============= |
| 20 | For API documentation, usage and examples see files in the "documentation" |
| 21 | directory. The ".rst" files can be read in any text editor or being converted to |
| Jakub Wilk | 772a6fa | 2016-12-20 21:59:27 +0100 | [diff] [blame] | 22 | HTML or PDF using Sphinx_. An HTML version is online at |
| Chris Liechti | 80e2ae2 | 2015-08-04 02:59:50 +0200 | [diff] [blame] | 23 | https://pythonhosted.org/pyserial/ |
| cliechti | 89b4af1 | 2002-02-12 23:24:41 +0000 | [diff] [blame] | 24 | |
| cliechti | 10d58b2 | 2009-07-30 23:15:25 +0000 | [diff] [blame] | 25 | Examples |
| 26 | ======== |
| Chris Liechti | e2c3119 | 2015-08-08 20:54:49 +0200 | [diff] [blame] | 27 | Examples and unit tests are in the directory examples_. |
| cliechti | 89b4af1 | 2002-02-12 23:24:41 +0000 | [diff] [blame] | 28 | |
| 29 | |
| 30 | Installation |
| cliechti | 10d58b2 | 2009-07-30 23:15:25 +0000 | [diff] [blame] | 31 | ============ |
| Chris Liechti | 80e2ae2 | 2015-08-04 02:59:50 +0200 | [diff] [blame] | 32 | ``pip install pyserial`` should work for most users. |
| 33 | |
| Chris Liechti | c6af356 | 2015-08-04 03:41:49 +0200 | [diff] [blame] | 34 | Detailed information can be found in `documentation/pyserial.rst`_. |
| cliechti | 89b4af1 | 2002-02-12 23:24:41 +0000 | [diff] [blame] | 35 | |
| Chris Liechti | e2c3119 | 2015-08-08 20:54:49 +0200 | [diff] [blame] | 36 | The usual setup.py for Python_ libraries is used for the source distribution. |
| cliechti | 10d58b2 | 2009-07-30 23:15:25 +0000 | [diff] [blame] | 37 | Windows installers are also available (see download link above). |
| Chris Liechti | c6af356 | 2015-08-04 03:41:49 +0200 | [diff] [blame] | 38 | |
| shaunwbell | 4e6d6ec | 2017-08-02 06:12:10 -0700 | [diff] [blame] | 39 | or |
| 40 | |
| 41 | To install this package with conda run: |
| 42 | |
| 43 | ``conda install -c conda-forge pyserial`` |
| 44 | |
| 45 | conda builds are available for linux, mac and windows. |
| 46 | |
| Chris Liechti | c6af356 | 2015-08-04 03:41:49 +0200 | [diff] [blame] | 47 | .. _`documentation/pyserial.rst`: https://github.com/pyserial/pyserial/blob/master/documentation/pyserial.rst#installation |
| Chris Liechti | e2c3119 | 2015-08-08 20:54:49 +0200 | [diff] [blame] | 48 | .. _examples: https://github.com/pyserial/pyserial/blob/master/examples |
| 49 | .. _Python: http://python.org/ |
| 50 | .. _Sphinx: http://sphinx-doc.org/ |
| Chris Liechti | af1319b | 2015-09-15 00:22:43 +0200 | [diff] [blame] | 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 |
| Chris Liechti | 388faab | 2015-09-15 00:42:43 +0200 | [diff] [blame] | 54 | .. |docs| image:: https://readthedocs.org/projects/pyserial/badge/?version=latest |
| Chris Liechti | bf6d3aa | 2016-04-28 23:49:37 +0200 | [diff] [blame] | 55 | :target: http://pyserial.readthedocs.io/ |
| Chris Liechti | 388faab | 2015-09-15 00:42:43 +0200 | [diff] [blame] | 56 | :alt: Documentation |