Browse Source

Initial commit

Sebastian Lohff 1 year ago
commit
bd31b70e44
8 changed files with 457 additions and 0 deletions
  1. 3
    0
      .gitignore
  2. 202
    0
      LICENSE
  3. 5
    0
      README.md
  4. 11
    0
      clintermission/__init__.py
  5. 200
    0
      clintermission/climenu.py
  6. 1
    0
      requirements.txt
  7. 29
    0
      setup.cfg
  8. 6
    0
      setup.py

+ 3
- 0
.gitignore View File

@@ -0,0 +1,3 @@
1
+__pycache__
2
+*.swp
3
+*.egg-info/

+ 202
- 0
LICENSE View File

@@ -0,0 +1,202 @@
1
+                                 Apache License
2
+                           Version 2.0, January 2004
3
+                        http://www.apache.org/licenses/
4
+
5
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+   1. Definitions.
8
+
9
+      "License" shall mean the terms and conditions for use, reproduction,
10
+      and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+      "Licensor" shall mean the copyright owner or entity authorized by
13
+      the copyright owner that is granting the License.
14
+
15
+      "Legal Entity" shall mean the union of the acting entity and all
16
+      other entities that control, are controlled by, or are under common
17
+      control with that entity. For the purposes of this definition,
18
+      "control" means (i) the power, direct or indirect, to cause the
19
+      direction or management of such entity, whether by contract or
20
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+      outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+      "You" (or "Your") shall mean an individual or Legal Entity
24
+      exercising permissions granted by this License.
25
+
26
+      "Source" form shall mean the preferred form for making modifications,
27
+      including but not limited to software source code, documentation
28
+      source, and configuration files.
29
+
30
+      "Object" form shall mean any form resulting from mechanical
31
+      transformation or translation of a Source form, including but
32
+      not limited to compiled object code, generated documentation,
33
+      and conversions to other media types.
34
+
35
+      "Work" shall mean the work of authorship, whether in Source or
36
+      Object form, made available under the License, as indicated by a
37
+      copyright notice that is included in or attached to the work
38
+      (an example is provided in the Appendix below).
39
+
40
+      "Derivative Works" shall mean any work, whether in Source or Object
41
+      form, that is based on (or derived from) the Work and for which the
42
+      editorial revisions, annotations, elaborations, or other modifications
43
+      represent, as a whole, an original work of authorship. For the purposes
44
+      of this License, Derivative Works shall not include works that remain
45
+      separable from, or merely link (or bind by name) to the interfaces of,
46
+      the Work and Derivative Works thereof.
47
+
48
+      "Contribution" shall mean any work of authorship, including
49
+      the original version of the Work and any modifications or additions
50
+      to that Work or Derivative Works thereof, that is intentionally
51
+      submitted to Licensor for inclusion in the Work by the copyright owner
52
+      or by an individual or Legal Entity authorized to submit on behalf of
53
+      the copyright owner. For the purposes of this definition, "submitted"
54
+      means any form of electronic, verbal, or written communication sent
55
+      to the Licensor or its representatives, including but not limited to
56
+      communication on electronic mailing lists, source code control systems,
57
+      and issue tracking systems that are managed by, or on behalf of, the
58
+      Licensor for the purpose of discussing and improving the Work, but
59
+      excluding communication that is conspicuously marked or otherwise
60
+      designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+      "Contributor" shall mean Licensor and any individual or Legal Entity
63
+      on behalf of whom a Contribution has been received by Licensor and
64
+      subsequently incorporated within the Work.
65
+
66
+   2. Grant of Copyright License. Subject to the terms and conditions of
67
+      this License, each Contributor hereby grants to You a perpetual,
68
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+      copyright license to reproduce, prepare Derivative Works of,
70
+      publicly display, publicly perform, sublicense, and distribute the
71
+      Work and such Derivative Works in Source or Object form.
72
+
73
+   3. Grant of Patent License. Subject to the terms and conditions of
74
+      this License, each Contributor hereby grants to You a perpetual,
75
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+      (except as stated in this section) patent license to make, have made,
77
+      use, offer to sell, sell, import, and otherwise transfer the Work,
78
+      where such license applies only to those patent claims licensable
79
+      by such Contributor that are necessarily infringed by their
80
+      Contribution(s) alone or by combination of their Contribution(s)
81
+      with the Work to which such Contribution(s) was submitted. If You
82
+      institute patent litigation against any entity (including a
83
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+      or a Contribution incorporated within the Work constitutes direct
85
+      or contributory patent infringement, then any patent licenses
86
+      granted to You under this License for that Work shall terminate
87
+      as of the date such litigation is filed.
88
+
89
+   4. Redistribution. You may reproduce and distribute copies of the
90
+      Work or Derivative Works thereof in any medium, with or without
91
+      modifications, and in Source or Object form, provided that You
92
+      meet the following conditions:
93
+
94
+      (a) You must give any other recipients of the Work or
95
+          Derivative Works a copy of this License; and
96
+
97
+      (b) You must cause any modified files to carry prominent notices
98
+          stating that You changed the files; and
99
+
100
+      (c) You must retain, in the Source form of any Derivative Works
101
+          that You distribute, all copyright, patent, trademark, and
102
+          attribution notices from the Source form of the Work,
103
+          excluding those notices that do not pertain to any part of
104
+          the Derivative Works; and
105
+
106
+      (d) If the Work includes a "NOTICE" text file as part of its
107
+          distribution, then any Derivative Works that You distribute must
108
+          include a readable copy of the attribution notices contained
109
+          within such NOTICE file, excluding those notices that do not
110
+          pertain to any part of the Derivative Works, in at least one
111
+          of the following places: within a NOTICE text file distributed
112
+          as part of the Derivative Works; within the Source form or
113
+          documentation, if provided along with the Derivative Works; or,
114
+          within a display generated by the Derivative Works, if and
115
+          wherever such third-party notices normally appear. The contents
116
+          of the NOTICE file are for informational purposes only and
117
+          do not modify the License. You may add Your own attribution
118
+          notices within Derivative Works that You distribute, alongside
119
+          or as an addendum to the NOTICE text from the Work, provided
120
+          that such additional attribution notices cannot be construed
121
+          as modifying the License.
122
+
123
+      You may add Your own copyright statement to Your modifications and
124
+      may provide additional or different license terms and conditions
125
+      for use, reproduction, or distribution of Your modifications, or
126
+      for any such Derivative Works as a whole, provided Your use,
127
+      reproduction, and distribution of the Work otherwise complies with
128
+      the conditions stated in this License.
129
+
130
+   5. Submission of Contributions. Unless You explicitly state otherwise,
131
+      any Contribution intentionally submitted for inclusion in the Work
132
+      by You to the Licensor shall be under the terms and conditions of
133
+      this License, without any additional terms or conditions.
134
+      Notwithstanding the above, nothing herein shall supersede or modify
135
+      the terms of any separate license agreement you may have executed
136
+      with Licensor regarding such Contributions.
137
+
138
+   6. Trademarks. This License does not grant permission to use the trade
139
+      names, trademarks, service marks, or product names of the Licensor,
140
+      except as required for reasonable and customary use in describing the
141
+      origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+   7. Disclaimer of Warranty. Unless required by applicable law or
144
+      agreed to in writing, Licensor provides the Work (and each
145
+      Contributor provides its Contributions) on an "AS IS" BASIS,
146
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+      implied, including, without limitation, any warranties or conditions
148
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+      PARTICULAR PURPOSE. You are solely responsible for determining the
150
+      appropriateness of using or redistributing the Work and assume any
151
+      risks associated with Your exercise of permissions under this License.
152
+
153
+   8. Limitation of Liability. In no event and under no legal theory,
154
+      whether in tort (including negligence), contract, or otherwise,
155
+      unless required by applicable law (such as deliberate and grossly
156
+      negligent acts) or agreed to in writing, shall any Contributor be
157
+      liable to You for damages, including any direct, indirect, special,
158
+      incidental, or consequential damages of any character arising as a
159
+      result of this License or out of the use or inability to use the
160
+      Work (including but not limited to damages for loss of goodwill,
161
+      work stoppage, computer failure or malfunction, or any and all
162
+      other commercial damages or losses), even if such Contributor
163
+      has been advised of the possibility of such damages.
164
+
165
+   9. Accepting Warranty or Additional Liability. While redistributing
166
+      the Work or Derivative Works thereof, You may choose to offer,
167
+      and charge a fee for, acceptance of support, warranty, indemnity,
168
+      or other liability obligations and/or rights consistent with this
169
+      License. However, in accepting such obligations, You may act only
170
+      on Your own behalf and on Your sole responsibility, not on behalf
171
+      of any other Contributor, and only if You agree to indemnify,
172
+      defend, and hold each Contributor harmless for any liability
173
+      incurred by, or claims asserted against, such Contributor by reason
174
+      of your accepting any such warranty or additional liability.
175
+
176
+   END OF TERMS AND CONDITIONS
177
+
178
+   APPENDIX: How to apply the Apache License to your work.
179
+
180
+      To apply the Apache License to your work, attach the following
181
+      boilerplate notice, with the fields enclosed by brackets "[]"
182
+      replaced with your own identifying information. (Don't include
183
+      the brackets!)  The text should be enclosed in the appropriate
184
+      comment syntax for the file format. We also recommend that a
185
+      file or class name and description of purpose be included on the
186
+      same "printed page" as the copyright notice for easier
187
+      identification within third-party archives.
188
+
189
+   Copyright [yyyy] [name of copyright owner]
190
+
191
+   Licensed under the Apache License, Version 2.0 (the "License");
192
+   you may not use this file except in compliance with the License.
193
+   You may obtain a copy of the License at
194
+
195
+       http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+   Unless required by applicable law or agreed to in writing, software
198
+   distributed under the License is distributed on an "AS IS" BASIS,
199
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+   See the License for the specific language governing permissions and
201
+   limitations under the License.
202
+

+ 5
- 0
README.md View File

@@ -0,0 +1,5 @@
1
+# CLI-Intermission
2
+Tool to easily ask your user questions on the commandline. Interactive!
3
+...by abusing python prompt-toolkit's `Buffer` class.
4
+
5
+Highly inspired by [go promptui](https://github.com/manifoldco/promptui)

+ 11
- 0
clintermission/__init__.py View File

@@ -0,0 +1,11 @@
1
+# Written by Sebastian Lohff <seba@someserver.de>
2
+# Licensed under Apache License 2.0
3
+
4
+from clintermission.climenu import CliMenu, CliMenuStyle, CliMenuCursor, CliMenuTheme
5
+
6
+__all__ = [
7
+    CliMenu,
8
+    CliMenuStyle,
9
+    CliMenuCursor,
10
+    CliMenuTheme,
11
+]

+ 200
- 0
clintermission/climenu.py View File

@@ -0,0 +1,200 @@
1
+# Written by Sebastian Lohff <seba@someserver.de>
2
+# Licensed under Apache License 2.0
3
+from prompt_toolkit.application import Application
4
+from prompt_toolkit.layout import Layout, Window, HSplit
5
+from prompt_toolkit.buffer import Buffer
6
+from prompt_toolkit.layout.controls import BufferControl
7
+from prompt_toolkit.key_binding import KeyBindings
8
+from prompt_toolkit.document import Document
9
+from prompt_toolkit.layout.processors import Processor, Transformation
10
+
11
+
12
+class CliMenuHeader:
13
+    """Hold a menu header"""
14
+    def __init__(self, text, indent=False):
15
+        self.text = text
16
+        self.indent = indent
17
+        self.focusable = False
18
+
19
+
20
+class CliMenuOption:
21
+    """Hold a menu option"""
22
+    def __init__(self, text, num):
23
+        self.text = text
24
+        self.num = num
25
+        self.focusable = True
26
+
27
+
28
+class CliMenuCursor:
29
+    """Collection of cursors pointing at the active menu item"""
30
+    BULLET = '●'
31
+    TRIANGLE = '▶'
32
+    CLI_STAR = '*'
33
+    CLI_ARROW = '-->'
34
+    CLI_CAT = '=^.^='
35
+    CAT = '😸'
36
+    ARROW = '→'
37
+
38
+
39
+class CliMenuStyle:
40
+    """Style for a menu
41
+
42
+    Allows to select header, option and selected option color
43
+    """
44
+    def __init__(self, option_style='', highlight_style='', header_style=''):
45
+        self.option_style = option_style
46
+        self.highlight_style = highlight_style
47
+        self.header_style = header_style
48
+
49
+        # self.option_color = '#aa0000'
50
+        # #self.highlight_color = 'fg:ansiblue bg:ansired bold'
51
+        # self.highlight_color = 'bold'
52
+        # self.cursor = ' --> '
53
+        # self.cursor = ' ● '
54
+        # self.no_cursor = '     '
55
+        # self.header_color = '#aa22cc'
56
+        # self.option_indent = 4
57
+        # self.header_indent = 4
58
+
59
+
60
+class CliMenuTheme:
61
+    BASIC = CliMenuStyle()
62
+    BASIC_BOLD = CliMenuStyle(header_style='bold', highlight_style='bold')
63
+    RED = CliMenuStyle('#aa0000', '#ee0000', '#aa0000')
64
+    CYAN = CliMenuStyle('cyan', 'lightcyan', 'cyan')
65
+    BLUE = CliMenuStyle('ansiblue', 'ansired', 'ansiblue')
66
+    ANSI_CYAN = CliMenuStyle('ansicyan', 'ansibrightcyan', 'ansicyan')
67
+
68
+
69
+class CliMenu:
70
+    default_stye = CliMenuTheme.BASIC
71
+    default_cursor = CliMenuCursor.TRIANGLE
72
+
73
+    def __init__(self, options=None, header=None, cursor=None, style=None,
74
+                 indent=2, dedent_selection=False):
75
+        self._items = []
76
+        self._item_num = 0
77
+        self._ran = False
78
+        self._success = None
79
+        self._pos = 0
80
+        self._option_indent = indent
81
+        self._header_indent = indent
82
+        self._dedent_selection = dedent_selection
83
+
84
+        self._cursor = cursor
85
+        if not self._cursor:
86
+            self._cursor = self.default_cursor
87
+
88
+        self._style = style
89
+        if not self._style:
90
+            self._style = self.default_stye
91
+
92
+        if header:
93
+            self.add_header(header)
94
+
95
+        if options:
96
+            for option in options:
97
+                self.add_option(option)
98
+
99
+    def add_header(self, title, indent=False):
100
+        for text in title.split('\n'):
101
+            self._items.append(CliMenuHeader(text))
102
+
103
+    def add_option(self, text):
104
+        self._items.append(CliMenuOption(text, self._item_num))
105
+        self._item_num += 1
106
+
107
+    def get_selection(self):
108
+        if not self._ran:
109
+            self._run()
110
+
111
+        return self._items[self._pos].num
112
+
113
+    def cursor(self):
114
+        return '{} '.format(self._cursor)
115
+
116
+    @property
117
+    def no_cursor(self):
118
+        # cursor with spaces minus dedent
119
+        return ' ' * (len(self._cursor) + 1 * self._dedent_selection)
120
+
121
+    def _transform_line(self, ti):
122
+        style, text = list(ti.fragments)[0]
123
+        item = self._items[ti.lineno]
124
+        s = self._style
125
+
126
+        # cursor
127
+        indent = ''
128
+        prefix = ''
129
+        if item.focusable:
130
+            indent += ' ' * self._option_indent
131
+
132
+            if ti.lineno == self._pos:
133
+                prefix += '{} '.format(self._cursor)
134
+                style = s.highlight_style
135
+            else:
136
+                prefix += ' ' * (len(self._cursor) + 1 + 1 * self._dedent_selection)
137
+                style = s.option_style
138
+        else:
139
+            if item.indent:
140
+                indent += ' ' * self._header_indent
141
+            style = s.header_style
142
+
143
+        return Transformation([('', indent), (style, prefix + text)])
144
+
145
+    def next_item(self, direction):
146
+        if not any(item.focusable for item in self._items):
147
+            raise RuntimeError("No focusable item found")
148
+
149
+        while True:
150
+            self._pos = (self._pos + direction) % len(self._items)
151
+            if self._items[self._pos].focusable:
152
+                break
153
+
154
+    def _run(self):
155
+        class MenuColorizer(Processor):
156
+            def apply_transformation(_self, ti):
157
+                return self._transform_line(ti)
158
+
159
+        # keybindings
160
+        self._kb = KeyBindings()
161
+
162
+        @self._kb.add('q')
163
+        @self._kb.add('c-c')
164
+        def quit(event):
165
+            event.app.exit()
166
+
167
+        @self._kb.add('down')
168
+        def down(event):
169
+            self.next_item(1)
170
+
171
+        @self._kb.add('up')
172
+        def up(event):
173
+            self.next_item(-1)
174
+
175
+        @self._kb.add('right')
176
+        @self._kb.add('c-m')
177
+        @self._kb.add('c-space')
178
+        def accept(event):
179
+            self._success = True
180
+            event.app.exit()
181
+
182
+        # set initial pos
183
+        if not self._items[self._pos].focusable:
184
+            self.next_item(1)
185
+
186
+        text = '\n'.join(map(lambda _x: _x.text, self._items))
187
+        self._doc = Document(text, cursor_position=self._pos)
188
+        self._buf = Buffer(read_only=True, document=self._doc)
189
+        self._bufctrl = BufferControl(self._buf,
190
+                                      input_processors=[MenuColorizer()])
191
+        split = HSplit([Window(self._bufctrl,
192
+                               wrap_lines=True,
193
+                               always_hide_cursor=True)])
194
+        app = Application(layout=Layout(split),
195
+                          key_bindings=self._kb,
196
+                          full_screen=False,
197
+                          mouse_support=False)
198
+
199
+        app.run()
200
+        self._ran = True

+ 1
- 0
requirements.txt View File

@@ -0,0 +1 @@
1
+prompt-toolkit

+ 29
- 0
setup.cfg View File

@@ -0,0 +1,29 @@
1
+[metadata]
2
+name = clintermission
3
+version = 0.1.0
4
+author = Sebastian Lohff
5
+author-email = seba@someserver.de
6
+home-page = https://git.someserver.de/seba/clintermission
7
+description = Non-fullscreen commandline selection menu
8
+long-description = file: README.md
9
+platform = any
10
+keywords = cli, menu
11
+classifiers =
12
+    Development Status :: 3 - Alpha
13
+    Intended Audience :: Developers
14
+    Programming Language :: Python :: 3
15
+    Programming Language :: Python :: 3.5
16
+    Programming Language :: Python :: 3.6
17
+    Programming Language :: Python :: 3.7
18
+    License :: OSI Approved :: Apache Software License
19
+
20
+[options]
21
+python_requires = >= 3.5
22
+packages = clintermission
23
+setup_requires =
24
+    setuptools > 30.4.0
25
+install_requires =
26
+    prompt-toolkit
27
+
28
+[flake8]
29
+max-line-length = 120

+ 6
- 0
setup.py View File

@@ -0,0 +1,6 @@
1
+#!/usr/bin/env python3
2
+
3
+from setuptools import setup
4
+
5
+
6
+setup(setup_requires=['setuptools>=30.4.0'])

Loading…
Cancel
Save