summaryrefslogtreecommitdiffstats
path: root/docs/source/installation.rst
blob: fa20733ca52b54bad484fbf13582813d53b9be04 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
Installing the LIRC Python Package
==================================

Since this package is merely a wrapper around the LIRC
daemon, it is expected that LIRC is installed and setup
on the given system as well to be able to use the python
package.

Python Package
--------------

This package is hosted on PyPI and can be installed
through pip.

.. code-block:: bash

  $ pip install lirc

System LIRC Package
-------------------

While there are ports of LIRC to macOS and Windows,
the original Linux version is much easier to get
working and install.

Linux:

  * It is highly likely that the package manager on
    your system already has LIRC packaged up and ready
    to be installed for you.

Windows:

  * WinLIRC at http://winlirc.sourceforge.net/ is a port for Windows.
    It works a bit differently since it is just a collection of files
    in a folder that you run so you'll have to adjust the ``socket``
    and ``socket_path`` parameter. More information on that can be found
    at `Using LIRC on Windows <./using-lirc-on-windows.html>`_.