Skip to content

Commit 78a3d18

Browse files
authored
♻️ Overhaul CHANGES to use plain reStructuredText (#206)
See also: - tmux-python/tmuxp#484 - tmux-python/tmuxp@2c07a15
2 parents 1e5285c + 8c16bb1 commit 78a3d18

File tree

6 files changed

+480
-102
lines changed

6 files changed

+480
-102
lines changed

CHANGES

+102-79
Original file line numberDiff line numberDiff line change
@@ -4,140 +4,163 @@ Changelog
44

55
Here you can find the recent changes to libtmux
66

7-
- :release:`0.8.1 <2019-01-26>`
8-
- :bug:`117` Fix issue with renaming clients with tmux 2.7 on BSD/macOS
7+
0.8.1 <2019-01-26>
8+
------------------
9+
- :issue:`117` Fix issue with renaming clients with tmux 2.7 on BSD/macOS
910
machines.
10-
- :support:`121` Support ``literal=True`` (``-l``) in ``Pane.send_keys``
11+
- :issue:`121` Support ``literal=True`` (``-l``) in ``Pane.send_keys``
1112
from @ritiek
12-
- :bug:`131` Fix for unicode commands in Python 2, thanks @myw
13-
- :support:`172` Support for next-X.Y versions from @sloria
14-
- :support:`120` ``capture_pane`` support for ``Pane``
15-
- :support:`119` ``display_message`` support for ``Pane``
16-
- :support:`-` Sort imports with isort
17-
- :support:`-` Add sphinxcontrib-napoleon package for documentation
18-
- :support:`-` Move docstrings over to numpy's style
19-
20-
- :release:`0.8.0 <2018-03-11>`
21-
- :support:`46` Change license from BSD to MIT
22-
- :support:`-` Move to new organization, tmux-python
23-
- :support:`-` Support package updates to pytest, sphinx, etc.
24-
- :support:`-` Travis/CI: Limit tests to Python 2.7 and 3.6 (removed 3.3 to 3.5)
25-
- :support:`-` Travis/CI: Update pypy veersions
26-
- :feature:`103` ``Server.new_session`` learned how to run commands in
13+
- :issue:`131` Fix for unicode commands in Python 2, thanks @myw
14+
- :issue:`172` Support for next-X.Y versions from @sloria
15+
- :issue:`120` ``capture_pane`` support for ``Pane``
16+
- :issue:`119` ``display_message`` support for ``Pane``
17+
- Sort imports with isort
18+
- Add sphinxcontrib-napoleon package for documentation
19+
- Move docstrings over to numpy's style
20+
21+
0.8.0 <2018-03-11>
22+
------------------
23+
- :issue:`46` Change license from BSD to MIT
24+
- Move to new organization, tmux-python
25+
- Support package updates to pytest, sphinx, etc.
26+
- Travis/CI: Limit tests to Python 2.7 and 3.6 (removed 3.3 to 3.5)
27+
- Travis/CI: Update pypy veersions
28+
- :issue:`103` ``Server.new_session`` learned how to run commands in
2729
window on session start, thanks @grimpy!
28-
- :support:`68` Make Server.has_session() use returncode, thanks
30+
- :issue:`68` Make Server.has_session() use returncode, thanks
2931
@jlargentaye! This should make ``has_session`` more robust.
3032

31-
- :release:`0.7.8 <2018-03-04>`
32-
- :support:`-` Port ``retry`` function from tmuxp
33+
0.7.8 <2018-03-04>
34+
------------------
35+
- Port ``retry`` function from tmuxp
3336
(https://github.com/tmux-python/tmuxp/issues/354)
3437

35-
- :release:`0.7.7 <2017-11-10>`
36-
- :support:`-` Don't add -x/-y in tmux >= 2.6 if running tmuxp from inside
38+
0.7.7 <2017-11-10>
39+
------------------
40+
- Don't add -x/-y in tmux >= 2.6 if running tmuxp from inside
3741
client.
3842

39-
- :release:`0.7.6 <2017-11-09>`
40-
- :feature:`-` Allow ``Window.select_layout`` with no args
41-
- :bug:`-` Fix test where ``bell-`` was no longer ambiguous as of tmux 2.6
43+
0.7.6 <2017-11-09>
44+
------------------
45+
- Allow ``Window.select_layout`` with no args
46+
- Fix test where ``bell-`` was no longer ambiguous as of tmux 2.6
4247

43-
- :release:`0.7.5 <2017-10-07>`
44-
- :support:`- backported` Hotfix to support tmux 2.6 session creation
48+
0.7.5 <2017-10-07>
49+
------------------
50+
- Hotfix to support tmux 2.6 session creation
4551

46-
- :release:`0.7.4 <2017-08-19>`
47-
- :feature:`65` Add session id to commands, thanks `@askedrelic`_
52+
0.7.4 <2017-08-19>
53+
------------------
54+
- :issue:`65` Add session id to commands, thanks `@askedrelic`_
4855

49-
- :release:`0.7.3 <2017-05-29>`
50-
- :support:`-` Exact matches only supported on 2.1 and up
56+
0.7.3 <2017-05-29>
57+
------------------
58+
- Exact matches only supported on 2.1 and up
5159

52-
- :release:`0.7.2 <2017-05-29>`
53-
- :support:`-` Support exact matching in ``Server.has_session``
60+
0.7.2 <2017-05-29>
61+
------------------
62+
- Support exact matching in ``Server.has_session``
5463

55-
- :release:`0.7.1 <2017-04-28>`
56-
- :support:`37` Improve support for formatted options like
64+
0.7.1 <2017-04-28>
65+
------------------
66+
- :issue:`37` Improve support for formatted options like
5767
``pane-border-status``. Thanks @kaushalmodi.
5868

59-
- :release:`0.7.0 <2017-04-27>`
60-
- :support:`-` Support for python 2.6 dropped. New minimum version is 2.7
61-
- :feature:`-` Add support for tmux 2.4, pypy and pypy3
62-
- :feature:`-` Overhaul error handling when setting and showing options
69+
0.7.0 <2017-04-27>
70+
------------------
71+
- Support for python 2.6 dropped. New minimum version is 2.7
72+
- Add support for tmux 2.4, pypy and pypy3
73+
- Overhaul error handling when setting and showing options
6374

6475
- Added `handle_option_error` for handling option errors
6576
- Added :exc:`libtmux.exc.OptionError` base exception
6677
- Added :exc:`libtmux.exc.InvalidOption` and `libtmux.exc.AmbiguousOption`
6778
- :exc:`libtmux.exc.UnknownOption` now extends :exc:`libtmux.exc.OptionError`
6879

69-
- :feature:`-` Overhaul version checking
80+
- Overhaul version checking
7081

7182
- ``has_version`` has been renamed to ``get_version``
7283
- ``get_version`` will return tmux built from git master as the latest version supported by the libtmux version with ``-master`` at the end, e.g. ``2.4-master``
7384
- ``get_version`` will return tmux on openbsd base system as the latest version supported by the libtmux version with ``-openbsd`` at the end, e.g. ``2.4-openbsd``
7485
- ``has_required_tmux_version`` has been renamed to ``has_minimum_version``
7586
- added ``has_gt_version``, ``has_gte_version``, ``has_lt_version``, ``has_lte_version``,
7687

77-
- :support:`-` Fixed up documentation in some session methods
78-
- :support:`-` Added pydoc exception info to option methods in window and sessions.
79-
- :support:`-` Added ``TMUX_MIN_VERSION`` and ``TMUX_MAX_VERSION``
88+
- Fixed up documentation in some session methods
89+
- Added pydoc exception info to option methods in window and sessions.
90+
- Added ``TMUX_MIN_VERSION`` and ``TMUX_MAX_VERSION``
8091

81-
- :release:`0.6.5 <2017-04-02>`
82-
- :support:`-` Fix ``which`` command
83-
- :support:`-` Add ``TmuxCommandNotFound`` exception
84-
- :support:`-` Add ``tmux_search_paths`` and ``append_env_path`` kwargs to
92+
0.6.5 <2017-04-02>
93+
------------------
94+
- Fix ``which`` command
95+
- Add ``TmuxCommandNotFound`` exception
96+
- Add ``tmux_search_paths`` and ``append_env_path`` kwargs to
8597
``tmux_cmd``.
8698

87-
- :release:`0.6.4 <2017-03-25>`
88-
- :support:`32` support for OpenBSD's tmux
99+
0.6.4 <2017-03-25>
100+
------------------
101+
- :issue:`32` support for OpenBSD's tmux
89102

90-
- :release:`0.6.3 <2017-02-08>`
91-
- :support:`25` support for working with tmux ``master``, thanks @sloria.
103+
0.6.3 <2017-02-08>
104+
------------------
105+
- :issue:`25` support for working with tmux ``master``, thanks @sloria.
92106

93-
- :release:`0.6.2 <2017-01-19>`
94-
- :support:`197` use `LooseVersion` instead of `StrictVersion` for version
107+
0.6.2 <2017-01-19>
108+
------------------
109+
- :issue:`197` use `LooseVersion` instead of `StrictVersion` for version
95110
checks. Thanks @minijackson.
96-
- :support:`-` Pin packages with pyup.io
97-
- :support:`21` Readme fix from @huwenchao.
111+
- Pin packages with pyup.io
112+
- :issue:`21` Readme fix from @huwenchao.
98113

99-
- :release:`0.6.1 <2016-12-20>`
100-
- :support:`18` Fix logger, courtesy of @geekli
101-
- :support:`19` Add support for ``start_directory`` in new sessions and
114+
0.6.1 <2016-12-20>
115+
------------------
116+
- :issue:`18` Fix logger, courtesy of @geekli
117+
- :issue:`19` Add support for ``start_directory`` in new sessions and
102118
panes, courtesy of @gandelman-a.
103-
- :support:`-` Fix tests and add official support for 2.3
119+
- Fix tests and add official support for 2.3
104120

105-
- :release:`0.6.0 <2016-09-16>`
106-
- :support:`-` Raise exception for invalid session names. tmux does not
121+
0.6.0 <2016-09-16>
122+
------------------
123+
- Raise exception for invalid session names. tmux does not
107124
allow names that are empty, contain periods or colons.
108-
- :bug:`-` Remove unused ``target_sesssion`` param in
125+
- Remove unused ``target_sesssion`` param in
109126
``Server.attach_session`` and ``Server.switch_client``.
110127

111-
- :release:`0.5.1 <2016-08-18>`
112-
- :bug:`12` - fix logger message when tmux doesn't exist in ``PATH``
128+
0.5.1 <2016-08-18>
129+
------------------
130+
- :issue:`12` - fix logger message when tmux doesn't exist in ``PATH``
113131

114-
- :release:`0.5 <2016-06-15>`
115-
- :feature:`8` new exception ``UnknownOption``
116-
- :feature:`8` return ``None`` for options that are valid tmux options,
132+
0.5 <2016-06-15>
133+
----------------
134+
- :issue:`8` new exception ``UnknownOption``
135+
- :issue:`8` return ``None`` for options that are valid tmux options,
117136
but unset at that scope.
118-
- :support:`6` major documentation overhaul
137+
- :issue:`6` major documentation overhaul
119138

120-
- :release:`0.4.1 <2016-05-23>`
121-
- :support:`-` update ``which()`` to find tmux via ``os.environ['PATH']``.
139+
0.4.1 <2016-05-23>
140+
------------------
141+
- update ``which()`` to find tmux via ``os.environ['PATH']``.
122142
https://redd.it/4laeut
123143

124-
- :release:`0.4.0 <2016-05-23>`
125-
- :support:`-` attributes for formatters are now accessible via
144+
0.4.0 <2016-05-23>
145+
------------------
146+
- attributes for formatters are now accessible via
126147
``Session``, ``Window`` and ``Pane`` objects. ``session.name``
127148
is equivalent to ``session.get('session_name')``, you can do the
128149
same with other properties in ``_info``. ``window.name``,
129150
``pane.current_path``, ``session.id``, ``window.id``, ``pane.id``,
130151
``session.index``, ``window.index``, ``pane.index``, etc.
131-
- :support:`-` ``attached_sessions``, ``attached_window`` and
152+
- ``attached_sessions``, ``attached_window`` and
132153
``attached_pane`` are now properties.
133-
- :support:`-` ``_TMUX`` metadata object changed to ``_info``.
134-
- :support:`-` ``.findWhere()`` is now ``find_where``.
135-
- :support:`-` README and usage fixes
154+
- ``_TMUX`` metadata object changed to ``_info``.
155+
- ``.findWhere()`` is now ``find_where``.
156+
- README and usage fixes
136157

137-
- :release:`0.3.0 <2016-05-23>`
158+
0.3.0 <2016-05-23>
159+
------------------
138160
- switch to pytest
139161

140-
- :release:`0.1.0 <2016-05-22>`
162+
0.1.0 <2016-05-22>
163+
------------------
141164
- libtmux forked from `tmuxp`_.
142165

143166
.. _tmuxp: https://github.com/tmux-python/tmuxp

Makefile

-6
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,3 @@ flake8:
3232

3333
watch_flake8:
3434
if command -v entr > /dev/null; then ${PY_FILES} | entr -c $(MAKE) flake8; else $(MAKE) flake8 entr_warn; fi
35-
36-
sync_pipfile:
37-
pipenv install --skip-lock --dev -r requirements/doc.txt && \
38-
pipenv install --skip-lock --dev -r requirements/dev.txt && \
39-
pipenv install --skip-lock --dev -r requirements/test.txt && \
40-
pipenv install --skip-lock --dev -e .

Pipfile

+8-8
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ verify_ssl = true
44
name = "pypi"
55

66
[dev-packages]
7-
docutils = "==0.14"
8-
releases = {git = "https://github.com/tony/releases.git",ref = "future-releases-uri-config"}
9-
alagitpull = "==0.0.22"
10-
sphinxcontrib-napoleon = "==0.7"
11-
Sphinx = "==2.0.1"
12-
isort = "==4.3.18"
13-
flake8 = "==3.7.7"
14-
pytest = "==4.5.0"
7+
docutils = "*"
8+
alagitpull = "*"
9+
Sphinx = ">=2.0.0"
10+
isort = "*"
11+
flake8 = "*"
12+
pytest = "*"
1513
libtmux = {path = ".",editable = true}
14+
black = "==19.3b0"
15+
sphinx-issues = "*"
1616

1717
[packages]
1818

0 commit comments

Comments
 (0)