Improve readme example, change DialogBox arg to , patch .gitignore, change lib version number.

Author: Tim-ats-d

.gitignore

@@ -1,5 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
 .vscode
 .idea
-
-# Sphinx documentation
-/doc/build/

README.md

@@ -72,11 +72,14 @@ import curses
 from visualdialog import DialogBox
 
 
+x, y = (0, 0)
+length, width = (35, 6)
+
 def main(stdscr):
     curses.curs_set(False)
 
-    textbox = DialogBox(0, 0,
-                        35, 6,
+    textbox = DialogBox(x, y,
+                        length, width,
                         title="Demo")
     textbox.char_by_char(stdscr,
                          "Hello world")

tests/test.py

@@ -18,16 +18,15 @@ def main(stdscr):
 
     curses.curs_set(0)
 
-    curses.start_color()
     curses.init_pair(1, curses.COLOR_RED, curses.COLOR_BLACK)
     curses.init_pair(2, curses.COLOR_CYAN, curses.COLOR_BLACK)
     curses.init_pair(3, curses.COLOR_GREEN, curses.COLOR_BLACK)
 
     textbox = DialogBox(0, 0,
                         40, 6,
-                        # ~ title="Tim-ats-d",
-                        title_colors_pair_nb=3,
-                        end_dialog_indicator="o")
+                        # title="Tim-ats-d",
+                        # title_colors_pair_nb=3,
+                        end_indicator="o")
 
     textbox.confirm_dialog_key = (32, )
     textbox.panic_key = (10, )
@@ -44,9 +43,9 @@ def func(text: str):
         textbox.char_by_char(stdscr,
                              reply,
                              cargs=(reply, ),
-                             callback=func)
-                             # ~ text_attr=(curses.A_ITALIC, curses.A_BOLD),
-                             # ~ words_attr=special_words)
+                             callback=func,
+                             text_attr=(curses.A_ITALIC, curses.A_BOLD),
+                             words_attr=special_words)
 
     with visualdialog.TextAttributes(stdscr, curses.A_BOLD, curses.A_ITALIC):
         ...

visualdialog/__init__.py

@@ -2,7 +2,7 @@
 A library to make easier dialog box in terminal.
 """
 
-__version__ = 0.6
+__version__ = 0.7
 __author__ = "Timéo Arnouts"
 
 from .dialog import DialogBox

visualdialog/dialog.py

@@ -72,21 +72,21 @@ def __init__(
         downtime_chars: Union[Tuple[str],
                             List[str]] = (",", ".", ":", ";", "!", "?"),
         downtime_chars_delay: Numeric = .6,
-        end_dialog_indicator: str = "►"):
+        end_indicator: str = "►"):
         BaseTextBox.__init__(self,
                              pos_x, pos_y,
                              length, width,
                              title,
                              title_colors_pair_nb, title_text_attr,
                              downtime_chars, downtime_chars_delay)
 
-        self.end_dialog_indicator_char = end_dialog_indicator
-        self.end_dialog_indicator_pos_x = self.pos_x + self.length - 2
+        self.end_indicator_char = end_indicator
+        self.end_indicator_pos_x = self.pos_x + self.length - 2
 
         if self.title:
-            self.end_dialog_indicator_pos_y = self.pos_y + self.width + 1
+            self.end_indicator_pos_y = self.pos_y + self.width + 1
         else:
-            self.end_dialog_indicator_pos_y = self.pos_y + self.width - 1
+            self.end_indicator_pos_y = self.pos_y + self.width - 1
 
         self.text_wrapper = textwrap.TextWrapper(width=self.nb_char_max_line)
 
@@ -96,26 +96,26 @@ def __enter__(self):
     def __exit__(self, type, value, traceback):
         ...
 
-    def _display_end_dialog_indicator(
+    def _display_end_indicator(
         self,
         win: CursesWindow,
         text_attr: CursesTextAttributesConstants = (curses.A_BOLD,
                                                     curses.A_BLINK)):
-        """Displays an end of dialog indicator in the lower right corner
-        of textbox.
+        """Displays an end indicator in the lower right corner of
+        textbox.
 
         :param win: ``curses`` window object on which the method
             will have effect.
 
         :param text_attr: Text attributes of
-            ``end_dialog_indicator`` method. This defaults to
+            ``end_indicator`` method. This defaults to
             ``(curses.A_BOLD, curses.A_BLINK)``.
         """
-        if self.end_dialog_indicator_char:
+        if self.end_indicator_char:
             with TextAttributes(win, *text_attr):
-                win.addch(self.end_dialog_indicator_pos_y,
-                          self.end_dialog_indicator_pos_x,
-                          self.end_dialog_indicator_char)
+                win.addch(self.end_indicator_pos_y,
+                          self.end_indicator_pos_x,
+                          self.end_indicator_char)
 
     def char_by_char(
         self,
@@ -249,7 +249,7 @@ def char_by_char(
                     # Compensates for the space between words.
                     offsetting_x += len(word) + 1
 
-            self._display_end_dialog_indicator(win)
+            self._display_end_indicator(win)
             self.getkey(win)
 
     def word_by_word(
@@ -321,7 +321,6 @@ def word_by_word(
                 - Writing paragraph by paragraph.
                 - Writing each line of the current paragraph, word by
                   word.
-                - Calling ``_display_end_dialog_indicator`` method.
                 - Waits until a key contained in the class attribute
                   ``confirm_dialog_key`` was pressed before writing the
                   following paragraph.
@@ -380,5 +379,5 @@ def word_by_word(
 
                 callback(*cargs)
 
-            self._display_end_dialog_indicator(win)
+            self._display_end_indicator(win)
             self.getkey(win)