Optimisation of getkey method. Rewrite of code documentation. text argument is now wrapped to not go out the dialog box. Add posssibility to pass curses attrbuts via text_attributes argument in word_by_word and char_by_char methods and in dialog box title. Title of dialog box is now set to bold by default. Add a new example file nammed text_attributes.py. Add and improve code comments and examples. Fix some typo in file.

Tim-ats-d · Tim-ats-d · commit 83c2d3dd16e0 · 2020-11-30T19:07:19.000+01:00
diff --git a/README.md b/README.md
@@ -1,18 +1,60 @@
-# Visual Dialog (BETA)
-A library to make easier **dialog box** in **terminal** with [curses](https://docs.python.org/3/library/curses.html).
+<p align="center">
+    <img width="300" src="https://user-images.githubusercontent.com/59396366/100594532-188c6900-32fa-11eb-8372-4796f53b122f.png" alt="Visual-dialog">
+    <br><br>
+    Library to make easier dialog box in terminal.
+</p>
 
-![example](https://user-images.githubusercontent.com/59396366/98136859-a9218600-1ec1-11eb-9419-4ac5bfde2406.png)
+<p align="center">
+  <a href="#features">Features</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#documentation">Documentation</a> •
+  <a href="#quick-start ">Usage</a> •
+  <a href="#contributing">Contributing</a> •
+  <a href="#license">License</a>
+</p>
 
+<div align="center">
+  <img src="https://user-images.githubusercontent.com/59396366/100640592-e3523c00-3336-11eb-8793-19a0543be8d0.gif" alt="Demo">
+</div>
 
-## Documentation
-Coming soon.
+## Features
+
+📃 Automatic text scrolling.
 
+🔖 Text coloring and formatting.
 
-### Quick start :
-* `pip install git+git://github.com/Tim-ats-d/Visual-dialog` (The lib is not yet available on **pypy**).
-* Read this [examples](https://github.com/Tim-ats-d/Visual-dialog/blob/main/doc/examples).
+⚙️ Hackable and configurable .
 
+## Installation
 
-## Requirements
+### Using pip
+`pip install git+git://github.com/Tim-ats-d/Visual-dialog`
+(The lib is not yet available on **pypy**).
+
+### Requirements
 * **Python 3.6** or more.
+* [`curses`](https://docs.python.org/3/library/curses.html) module (available on **UNIX** system by default).
 * Knowledge of [`curses`](https://docs.python.org/3/library/curses.html) librairie.
+
+## Quick-start
+
+Read these [examples](doc/examples/).
+
+## Documentation
+
+Coming soon !
+
+
+## Contributing
+
+We would love for you to contribute to improve **Visual-dialog**.
+
+Take a look at our [Contributing guide](CONTRIBUTING) to get started.
+
+## License
+
+Distributed under the **GPL-2.0 License** . See [LICENSE](LICENSE) for more information.
+
+## Acknowledgements
+
+Thanks to all those who contributed to **Visual-dialog** !
diff --git a/doc/examples/confrontation.py b/doc/examples/confrontation.py
@@ -16,75 +16,78 @@ def main(stdscr):
     curses.init_pair(2, curses.COLOR_MAGENTA, curses.COLOR_BLACK)
     curses.init_pair(3, curses.COLOR_RED, curses.COLOR_BLACK)
 
-    textbox_position = (20, 15)  # Position 20;15 in terminal.
+    textbox_position = (10, 10)  # Position 10;10 in terminal.
     textbox_dimension = (40, 6)  # Length and width (in character).
 
-    phoenix_textbox = DialogBox(
+    phoenix_wright = DialogBox(
         *textbox_position,
         *textbox_dimension,
         title="Phoenix", title_colors_pair_nb=1  # Title and color_pair used to colored title.
     )
 
-    april_may_textbox = DialogBox(
+    april_may = DialogBox(
         *textbox_position,
         *textbox_dimension,
         title="April", title_colors_pair_nb=2  # Title and color_pair used to colored title.
     )
 
-    edgeworth_textbox = DialogBox(
+    miles_edgeworth = DialogBox(
         *textbox_position,
         *textbox_dimension,
-        title="Edgeworth", title_colors_pair_nb=3
+        title="Edgeworth", title_colors_pair_nb=3  # Title and color_pair used to colored title.
     )
 
     # Definition of accepted key codes to pass a dialog.
     # See documentation of curses constants for more informations.
-    phoenix_textbox.confirm_dialog_key = (10, 32)     # Key Enter and Space.
-    april_may_textbox.confirm_dialog_key = (10, 32)  # Key Enter and Space.
-    edgeworth_textbox.confirm_dialog_key = (10, 32)   # Key Enter and Space.
+    phoenix_wright.confirm_dialog_key = (10, 32)     # Key Enter and Space.
+    april_may.confirm_dialog_key = (10, 32)  # Key Enter and Space.
+    miles_edgeworth.confirm_dialog_key = (10, 32)   # Key Enter and Space.
 
-    phoenix_textbox.char_by_char(stdscr,
+    phoenix_wright.char_by_char(stdscr,
         "This testimony is a pure invention !",
         colors_pair_nb=0,
         delay=0.03)
 
-    phoenix_textbox.getkey(stdscr)  # Wait until a key in phoenix_textbox.confirm_dialog_key list is pressed.
+    phoenix_wright.getkey(stdscr)  # Wait until a key contained in phoenix_wright.confirm_dialog_key is pressed.
     stdscr.clear()  # Clear the screen.
 
-    phoenix_textbox.char_by_char(stdscr,
+    phoenix_wright.char_by_char(stdscr,
         "You're lying April May !",
         colors_pair_nb=0,
         flash_screen=True,
-        delay=0.03)
+        delay=0.03,
+        text_attributes=(curses.A_BOLD,))
 
-    phoenix_textbox.getkey(stdscr)
+    phoenix_wright.getkey(stdscr)  # Wait until a key contained in phoenix_wright.confirm_dialog_key is pressed.
     stdscr.clear()
 
-    april_may_textbox.char_by_char(stdscr,
+    april_may.char_by_char(stdscr,
         "Arghh !",
         colors_pair_nb=0,
-        delay=0.02)
+        delay=0.02,
+        text_attributes=(curses.A_ITALIC,))
 
-    april_may_textbox.getkey(stdscr)  # Wait until a key in april_may_textbox.confirm_dialog_key list is pressed.
+    april_may.getkey(stdscr)  # Wait until a key contained in april_may.confirm_dialog_key is pressed.
     stdscr.clear()
 
-    edgeworth_textbox.char_by_char(stdscr,
+    miles_edgeworth.char_by_char(stdscr,
         "OBJECTION !",
         colors_pair_nb=0,
         flash_screen=True,
-        delay=0.03)
+        delay=0.03,
+        text_attributes=(curses.A_BOLD,)
+        )
 
-    edgeworth_textbox.getkey(stdscr)  # Wait until a key in edgeworth_textbox.confirm_dialog_key list is pressed.
+    miles_edgeworth.getkey(stdscr)  # Wait until a key contained in miles_edgeworth.confirm_dialog_key is pressed.
     stdscr.clear()
 
-    edgeworth_textbox.char_by_char(stdscr,
+    miles_edgeworth.char_by_char(stdscr,
         "These accusations are irrelevant !",
         colors_pair_nb=0,
         delay=0.03)
 
-    edgeworth_textbox.getkey(stdscr)
+    miles_edgeworth.getkey(stdscr)
     stdscr.clear()
 
 
-# Execution of the function.
-curses.wrapper(main)
+curses.wrapper(main)  # Execution of the function.
diff --git a/doc/examples/context.py b/doc/examples/context.py
@@ -1,43 +1,53 @@
 #!/usr/bin/env python3
-# context.py
+# monologue.py
 
 import curses
 
 from visualdialog import DialogBox
 
 
 def main(stdscr):
-    monologue = (
-        "I will be the narrator of this story.",
-        "I will guide you throughout your adventure."
-    )
-
     # Makes the cursor invisible.
     curses.curs_set(0)
 
     # Definition of several colors pairs.
     curses.start_color()
-    curses.init_pair(1, curses.COLOR_WHITE, curses.COLOR_BLACK)
-    curses.init_pair(2, curses.COLOR_CYAN, curses.COLOR_BLACK)
-
-    with DialogBox(
-            5, 5,  # Position 5;5 in terminal.
-            40, 6,  # Length and width (in character).
-            title="Narrator", title_colors_pair_nb=1) as narrator:  # We catch the dialog box with as.
-
-        # Definition of accepted key codes to pass a dialog.
-        # See documentation of the curses constants for more informations.
-        narrator.confirm_dialog_key = (10, 32)  # Key Enter and Space.
-
-        # We iterate on each sentence contained in monologue.
-        for text in monologue:
-            narrator.char_by_char(stdscr,
-                text,
-                2)  # Display of the reply variable colored with color pair 2.
-
-            narrator.getkey(stdscr)  # Waiting for a key press.
-            stdscr.clear()  # Clear the screen.
-
-
-# Execution of the function.
-curses.wrapper(main)
+    curses.init_pair(1, curses.COLOR_GREEN, curses.COLOR_BLACK)
+    curses.init_pair(2, curses.COLOR_WHITE, curses.COLOR_BLACK)
+
+    textbox = DialogBox(
+        0, 0,  # Position 0;0 in terminal.
+        40, 6,  # Length and width (in character).
+        title="Tim-ats-d",
+        title_colors_pair_nb=1,  # Title and color_pair used to colored title.
+        title_text_attributes=(curses.A_UNDERLINE, ))  # Attribute to underline the title.
+    # It is necessary to think of passing a tuple even if it contains only one element
+    # (see doc for more informations).
+
+    # Definition of accepted key codes to pass a dialog.
+    # See documentation of the curses constants for more informations.
+    textbox.confirm_dialog_key = (10, 32)  # Key Enter and Space.
+
+    sentences = {
+        "An important text.": (curses.A_BOLD, ),
+        "An action performed by a character.": (curses.A_ITALIC, ),
+        "An underlined text.": (curses.A_UNDERLINE, ),
+        "A very important text.": (curses.A_BOLD, curses.A_ITALIC),
+        "Incomprehensible gibberish ": (curses.A_ALTCHARSET, ),
+        "The colors of the front and the background reversed.":
+        (curses.A_REVERSE, ),
+    }
+
+    for text, attributs in sentences.items():
+        textbox.char_by_char(
+            stdscr,
+            text,
+            2,  # Display of the reply variable colored with color pair 2.
+            text_attributes=attributs)  # Pass the attributes to the text.
+
+        # Wait until a key contained in textbox.confirm_dialog_key is pressed.
+        textbox.getkey(stdscr)
+        stdscr.clear()  # Clear the screen.
+
+
+curses.wrapper(main)  # Execution of the function.
diff --git a/doc/examples/text_attributes.py b/doc/examples/text_attributes.py
@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+# monologue.py
+
+import curses
+
+from visualdialog import DialogBox
+
+
+def main(stdscr):
+    # Makes the cursor invisible.
+    curses.curs_set(0)
+
+    # Definition of several colors pairs.
+    curses.start_color()
+    curses.init_pair(1, curses.COLOR_GREEN, curses.COLOR_BLACK)
+    curses.init_pair(2, curses.COLOR_WHITE, curses.COLOR_BLACK)
+
+    textbox = DialogBox(
+        0, 0,  # Position 0;0 in terminal.
+        40, 6,  # Length and width (in character).
+        title="Tim-ats-d",
+        title_colors_pair_nb=1,  # Title and color_pair used to colored title.
+        title_text_attributes=(curses.A_UNDERLINE, ))  # Attribute to underline the title.
+    # It is necessary to think of passing a tuple even if it contains only one element
+    # (see doc for more informations).
+
+    # Definition of accepted key codes to pass a dialog.
+    # See documentation of the curses constants for more informations.
+    textbox.confirm_dialog_key = (10, 32)  # Key Enter and Space.
+
+    sentences = {
+        "An important text.": (curses.A_BOLD, ),
+        "An action performed by a character.": (curses.A_ITALIC, ),
+        "An underlined text.": (curses.A_UNDERLINE, ),
+        "A very important text.": (curses.A_BOLD, curses.A_ITALIC),
+        "Incomprehensible gibberish ": (curses.A_ALTCHARSET, ),
+        "The colors of the front and the background reversed.":
+        (curses.A_REVERSE, ),
+    }
+
+    for text, attributs in sentences.items():
+        textbox.char_by_char(
+            stdscr,
+            text,
+            2,  # Display of the reply variable colored with color pair 2.
+            text_attributes=attributs)  # Pass the attributes to the text.
+
+        # Wait until a key contained in textbox.confirm_dialog_key is pressed.
+        textbox.getkey(stdscr)
+        stdscr.clear()  # Clear the screen.
+
+
+curses.wrapper(main)  # Execution of the function.
diff --git a/setup.py b/setup.py
@@ -2,24 +2,21 @@
 
 from setuptools import setup, find_packages
 
-
 setup(
     name="visualdialog",
-    version=0.4,
+    version=0.6,
     packages=find_packages(),
     author="Arnouts Timéo",
     author_email="tim.arnouts@protonmail.com",
-    description="A librairie to make easier dialog box in terminal.",
+    description="A library to make easier dialog box in terminal.",
     long_description=open("README.md").read(),
     include_package_data=True,
     url="https://github.com/Tim-ats-d/Visual-dialog",
     classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Environment :: Console :: Curses",
+        "Development Status :: 3 - Alpha", "Environment :: Console :: Curses",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: GNU General Public License v2 (GPLv2)",
-        "Natural Language :: English",
-        "Natural Language :: French",
+        "Natural Language :: English", "Natural Language :: French",
         "Operating System :: POSIX :: Linux",
         "Programming Language :: Python :: 3.0",
         "Programming Language :: Python :: 3.1",
@@ -34,5 +31,5 @@
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: Implementation",
         "Topic :: Games/Entertainment :: Role-Playing",
-        "Topic :: Software Development :: Libraries :: Python Modules"]
-)
+        "Topic :: Software Development :: Libraries :: Python Modules"
+    ])
diff --git a/visualdialog/core.py b/visualdialog/core.py
