summaryrefslogtreecommitdiffstats
path: root/CHANGELOG.rst
blob: f724e7113ae4aad961ae9c0d6301a39791b4b86c (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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
Changelog
=========

All notable changes to this project will be documented in this file.

The format is based on `Keep a
Changelog <https://keepachangelog.com/en/1.0.0/>`_, and this project
adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.

1.0.1 - 2020-12-26
------------------

**Fixed**

- PyPI is complaining that v1.0.0 is already taken, since it was
  a release that was deleted from a previous mistake.

1.0.0 - 2020-12-26
------------------

**Added**

- ``DefaultConnection.address`` and ``DefaultConnection.socket`` may raises
  an ``UnsupportedOperatingSystemError`` if the operating system you're on
  is not MacOS, Linux, or Windows.

**Changed**

- ``lirc.Client`` raises a ``TypeError`` instead of a ``ValueError`` now
  if a ``connection`` is passed in that is not an instance of ``LircdConnection``.

- ``send`` on ``lirc.Client`` is now called ``send_once``.

- ``start_repeat`` on ``lirc.Client`` is now called ``send_start``.

- ``stop_repeat`` on ``lirc.Client`` is now called ``send_stop``.

**Removed**

- ``socket`` property from ``LircdConnection``.

**Fixed**

- The ``remote`` and ``key`` optional arguments to the ``lirc.Client``'s ``stop_repeat``
  method were not overriding the last sent remote and key.

0.2.0 - 2020-12-13
------------------

**Added**

- ``LircdConnection`` to handle configuring the connection on ``Client``.

**Changed**

- ``Lirc`` is now named ``Client``.

- ``Client`` now takes in a ``connection`` as the optional argument
  to configure it's connection. That ``connection`` must be a ``LircdConnection``
  class if you would like to customize the connection. The ``LircdConnection`` takes
  in an ``address``, ``socket``, and ``timeout`` with optional keyword arguments.
  Anything not specified with use the defaults for that operating system.

**Removed**

- ``DEFAULT_SOCKET_PATH`` constant on ``Client``. It no longer makes sense with cross-platform support.

- ``ENCODING`` constant on ``Client``.

- ``socket_path`` and ``socket_timeout`` on the ``Lirc`` constructor.

0.1.0 - 2020-07-13
------------------

- Initial Release