From bd31b70e443d401eb536614b6885d2bed789d24f Mon Sep 17 00:00:00 2001 From: Sebastian Lohff Date: Thu, 31 Jan 2019 23:58:29 +0100 Subject: [PATCH] Initial commit --- .gitignore | 3 + LICENSE | 202 +++++++++++++++++++++++++++++++++++++ README.md | 5 + clintermission/__init__.py | 11 ++ clintermission/climenu.py | 200 ++++++++++++++++++++++++++++++++++++ requirements.txt | 1 + setup.cfg | 29 ++++++ setup.py | 6 ++ 8 files changed, 457 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 clintermission/__init__.py create mode 100644 clintermission/climenu.py create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7cd051a --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +__pycache__ +*.swp +*.egg-info/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..57bc88a --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..09bc670 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +# CLI-Intermission +Tool to easily ask your user questions on the commandline. Interactive! +...by abusing python prompt-toolkit's `Buffer` class. + +Highly inspired by [go promptui](https://github.com/manifoldco/promptui) diff --git a/clintermission/__init__.py b/clintermission/__init__.py new file mode 100644 index 0000000..d001eb8 --- /dev/null +++ b/clintermission/__init__.py @@ -0,0 +1,11 @@ +# Written by Sebastian Lohff +# Licensed under Apache License 2.0 + +from clintermission.climenu import CliMenu, CliMenuStyle, CliMenuCursor, CliMenuTheme + +__all__ = [ + CliMenu, + CliMenuStyle, + CliMenuCursor, + CliMenuTheme, +] diff --git a/clintermission/climenu.py b/clintermission/climenu.py new file mode 100644 index 0000000..7f1dbcf --- /dev/null +++ b/clintermission/climenu.py @@ -0,0 +1,200 @@ +# Written by Sebastian Lohff +# Licensed under Apache License 2.0 +from prompt_toolkit.application import Application +from prompt_toolkit.layout import Layout, Window, HSplit +from prompt_toolkit.buffer import Buffer +from prompt_toolkit.layout.controls import BufferControl +from prompt_toolkit.key_binding import KeyBindings +from prompt_toolkit.document import Document +from prompt_toolkit.layout.processors import Processor, Transformation + + +class CliMenuHeader: + """Hold a menu header""" + def __init__(self, text, indent=False): + self.text = text + self.indent = indent + self.focusable = False + + +class CliMenuOption: + """Hold a menu option""" + def __init__(self, text, num): + self.text = text + self.num = num + self.focusable = True + + +class CliMenuCursor: + """Collection of cursors pointing at the active menu item""" + BULLET = '●' + TRIANGLE = '▶' + CLI_STAR = '*' + CLI_ARROW = '-->' + CLI_CAT = '=^.^=' + CAT = '😸' + ARROW = '→' + + +class CliMenuStyle: + """Style for a menu + + Allows to select header, option and selected option color + """ + def __init__(self, option_style='', highlight_style='', header_style=''): + self.option_style = option_style + self.highlight_style = highlight_style + self.header_style = header_style + + # self.option_color = '#aa0000' + # #self.highlight_color = 'fg:ansiblue bg:ansired bold' + # self.highlight_color = 'bold' + # self.cursor = ' --> ' + # self.cursor = ' ● ' + # self.no_cursor = ' ' + # self.header_color = '#aa22cc' + # self.option_indent = 4 + # self.header_indent = 4 + + +class CliMenuTheme: + BASIC = CliMenuStyle() + BASIC_BOLD = CliMenuStyle(header_style='bold', highlight_style='bold') + RED = CliMenuStyle('#aa0000', '#ee0000', '#aa0000') + CYAN = CliMenuStyle('cyan', 'lightcyan', 'cyan') + BLUE = CliMenuStyle('ansiblue', 'ansired', 'ansiblue') + ANSI_CYAN = CliMenuStyle('ansicyan', 'ansibrightcyan', 'ansicyan') + + +class CliMenu: + default_stye = CliMenuTheme.BASIC + default_cursor = CliMenuCursor.TRIANGLE + + def __init__(self, options=None, header=None, cursor=None, style=None, + indent=2, dedent_selection=False): + self._items = [] + self._item_num = 0 + self._ran = False + self._success = None + self._pos = 0 + self._option_indent = indent + self._header_indent = indent + self._dedent_selection = dedent_selection + + self._cursor = cursor + if not self._cursor: + self._cursor = self.default_cursor + + self._style = style + if not self._style: + self._style = self.default_stye + + if header: + self.add_header(header) + + if options: + for option in options: + self.add_option(option) + + def add_header(self, title, indent=False): + for text in title.split('\n'): + self._items.append(CliMenuHeader(text)) + + def add_option(self, text): + self._items.append(CliMenuOption(text, self._item_num)) + self._item_num += 1 + + def get_selection(self): + if not self._ran: + self._run() + + return self._items[self._pos].num + + def cursor(self): + return '{} '.format(self._cursor) + + @property + def no_cursor(self): + # cursor with spaces minus dedent + return ' ' * (len(self._cursor) + 1 * self._dedent_selection) + + def _transform_line(self, ti): + style, text = list(ti.fragments)[0] + item = self._items[ti.lineno] + s = self._style + + # cursor + indent = '' + prefix = '' + if item.focusable: + indent += ' ' * self._option_indent + + if ti.lineno == self._pos: + prefix += '{} '.format(self._cursor) + style = s.highlight_style + else: + prefix += ' ' * (len(self._cursor) + 1 + 1 * self._dedent_selection) + style = s.option_style + else: + if item.indent: + indent += ' ' * self._header_indent + style = s.header_style + + return Transformation([('', indent), (style, prefix + text)]) + + def next_item(self, direction): + if not any(item.focusable for item in self._items): + raise RuntimeError("No focusable item found") + + while True: + self._pos = (self._pos + direction) % len(self._items) + if self._items[self._pos].focusable: + break + + def _run(self): + class MenuColorizer(Processor): + def apply_transformation(_self, ti): + return self._transform_line(ti) + + # keybindings + self._kb = KeyBindings() + + @self._kb.add('q') + @self._kb.add('c-c') + def quit(event): + event.app.exit() + + @self._kb.add('down') + def down(event): + self.next_item(1) + + @self._kb.add('up') + def up(event): + self.next_item(-1) + + @self._kb.add('right') + @self._kb.add('c-m') + @self._kb.add('c-space') + def accept(event): + self._success = True + event.app.exit() + + # set initial pos + if not self._items[self._pos].focusable: + self.next_item(1) + + text = '\n'.join(map(lambda _x: _x.text, self._items)) + self._doc = Document(text, cursor_position=self._pos) + self._buf = Buffer(read_only=True, document=self._doc) + self._bufctrl = BufferControl(self._buf, + input_processors=[MenuColorizer()]) + split = HSplit([Window(self._bufctrl, + wrap_lines=True, + always_hide_cursor=True)]) + app = Application(layout=Layout(split), + key_bindings=self._kb, + full_screen=False, + mouse_support=False) + + app.run() + self._ran = True diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..a1e0926 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +prompt-toolkit diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..39b8143 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,29 @@ +[metadata] +name = clintermission +version = 0.1.0 +author = Sebastian Lohff +author-email = seba@someserver.de +home-page = https://git.someserver.de/seba/clintermission +description = Non-fullscreen commandline selection menu +long-description = file: README.md +platform = any +keywords = cli, menu +classifiers = + Development Status :: 3 - Alpha + Intended Audience :: Developers + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.5 + Programming Language :: Python :: 3.6 + Programming Language :: Python :: 3.7 + License :: OSI Approved :: Apache Software License + +[options] +python_requires = >= 3.5 +packages = clintermission +setup_requires = + setuptools > 30.4.0 +install_requires = + prompt-toolkit + +[flake8] +max-line-length = 120 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..b264bf3 --- /dev/null +++ b/setup.py @@ -0,0 +1,6 @@ +#!/usr/bin/env python3 + +from setuptools import setup + + +setup(setup_requires=['setuptools>=30.4.0'])