simple-terminal-banner 0.0.6__py3-none-any.whl

simple_terminal_banner/__init__.py

@@ -0,0 +1 @@
+from .banner import Banner, BannerThemes

simple_terminal_banner/banner.py

@@ -0,0 +1,209 @@
+from enum import Enum
+import logging
+import textwrap
+
+
+class BannerThemes(Enum):
+    DEFAULT = 'default'
+    SIMPLE = 'simple'
+    HASH = 'hash'
+    STAR = 'star'
+    SPACE = 'space'
+    NONE = 'none'
+
+
+# create a simple class to create a banner
+class Banner:
+    def __init__(self, message=None):
+
+        self.title = None
+        self.title_padding = 1
+        self.title_margin = 1
+        self.width = 40
+        self.wrap = True
+        self.padding_top = 1
+        self.padding_bottom = 1
+        self.padding_left = 1
+        self.padding_right = 1
+        self.margin_top = 0
+        self.margin_bottom = 1
+        self.margin_left = 0
+        self.margin_right = 0
+        self.border_symbol = "*"
+        self.background_symbol = " "
+        self.padding_symbol = " "
+
+        self._rows = []
+        self._border_width = 1
+
+        if message:
+            self.add_row(message)
+        self.message = message
+
+    def display(self):
+        if self.margin_top > 0: print(self._create_margin_top())
+        print(self._title())
+        print(self._create_padding_top())
+        if self._rows:
+            for row in self._rows:
+                print(row)
+        else:
+            print(self._line(self.message))
+        print(self._create_padding_bottom())
+        print(self._separator())
+        if self.margin_bottom > 0: print(self._create_margin_bottom())
+
+    def add_row(self, content=None, type=None):
+        if type in ['blank', 'empty', 'line']:
+            self._rows.append(self._blank_line())
+        elif type in ['separator', 'divider']:
+            self._rows.append(self._create_padding_top())
+            self._rows.append(self._separator())
+            self._rows.append(self._create_padding_bottom())
+        else:
+            # content = self._check_content_length(content)
+            self._line(content)
+
+        return
+
+    def set_message(self, message):
+        self._rows = []
+        self.add_row(message)
+
+    def set_wrap(self, wrap):
+        # if wrap is changed, we need to reprocess any existing rows
+        # to calculate the correct wrapping
+        self.wrap = wrap
+
+    def theme(self, theme_name):
+        if theme_name == "default":
+            self.border_symbol = "*"
+            self.background_symbol = " "
+            self.padding_symbol = " "
+        elif theme_name == "simple":
+            self.border_symbol = "-"
+            self.background_symbol = " "
+            self.padding_symbol = " "
+        elif theme_name == "hash":
+            self.border_symbol = "#"
+            self.background_symbol = " "
+            self.padding_symbol = " "
+        elif theme_name == "star":
+            self.border_symbol = "*"
+            self.background_symbol = " "
+            self.padding_symbol = " "
+        elif theme_name == "space":
+            self.border_symbol = " "
+            self.background_symbol = " "
+            self.padding_symbol = " "
+        elif theme_name == "none":
+            self.border_symbol = ""
+            self.background_symbol = ""
+            self.padding_symbol = ""
+            self.title_padding = 0
+            self.title_margin = 0
+        else:
+            self.border_symbol = "*"
+            self.background_symbol = " "
+            self.padding_symbol = " "
+
+    def _line(self, content):
+        checked_content_list = self._check_content_length(content)
+
+        for checked_content in checked_content_list:
+            self._rows.append(
+                self._create_row(checked_content)
+            )
+
+    def _create_row(self, content):
+        return (
+            f"{self.border_symbol}"
+            f"{self.padding_symbol * self.padding_left}"
+            f"{content}"
+            f"{self.background_symbol * int(self.width-len(content)-self.padding_left-self.padding_right-2)}"
+            f"{self.padding_symbol * self.padding_right}"
+            f"{self.border_symbol}"
+        )
+
+    def _check_content_length(self, content):
+        checked_content_list = []
+        if len(content) > self.width - \
+            (self.padding_left + self.padding_right) - \
+            (self._border_width * 2):
+            if self.wrap:
+                checked_content_list = textwrap.wrap(
+                    content,
+                    width=self.width-(self.padding_left+self.padding_right+(self._border_width*2)))
+                # for line in wrapped_content:
+                #     self.add_row(line)
+            else:
+                checked_content_list.append(content[:self.width-(self.padding_left+self.padding_right+(self._border_width*2))])
+        else:
+            checked_content_list.append(content)
+        return checked_content_list
+
+    def _title(self):
+        if self.title is None or self.title == "":
+            return self._separator()
+
+        if len(self.title) > self.width - (self._border_width * 2) - (self.title_margin * 2) - (self.title_padding * 2):
+            logging.warning(f"Title is too long ({len(self.title)} chars) and has been truncated to fit banner: Total width:{self.width}, Title margin {self.title_margin * 2}, Title padding {self.title_padding * 2}, Allowed Title Length:{self.width-(self.title_margin*2)-(self.title_padding*2)}.")
+            self.title = self.title[:self.width-(self._border_width*2)-(self.title_margin*2)-(self.title_padding*2)]
+
+        return (
+            f"{self.border_symbol}"
+            f"{self.border_symbol * self.title_margin}"
+            f"{' ' * self.title_padding}"
+            f"{self.title}"
+            f"{' ' * self.title_padding}"
+            f"{self.border_symbol * self.title_margin}"
+            f"{self.border_symbol * int(self.width-len(self.title)-(self._border_width*2)-(self.title_padding*2)-(self.title_margin*2))}"
+            f"{self.border_symbol}"
+        )
+
+    def _separator(self):
+        return self.border_symbol * self.width
+
+    def _create_padding_top(self):
+        padding_lines = ""
+        for i in range(self.padding_top):
+            padding_lines += self._padding_line() + "\n"
+
+        # remove the last newline character
+        return padding_lines[:-1]
+
+    def _create_padding_bottom(self):
+        padding_lines = ""
+        for i in range(self.padding_bottom):
+            padding_lines += self._padding_line() + "\n"
+
+        # remove the last newline character
+        return padding_lines[:-1]
+
+    def _create_margin_top(self):
+        margin_lines = ""
+        for i in range(self.margin_top):
+            margin_lines += "\n"
+
+        return margin_lines
+
+    def _create_margin_bottom(self):
+        margin_lines = ""
+        for i in range(self.margin_bottom):
+            margin_lines += "\n"
+
+        return margin_lines
+
+    def _padding_line(self):
+        return self.border_symbol \
+            + self.padding_symbol * self.padding_left \
+            + self.padding_symbol * (self.width - 2 - self.padding_left - self.padding_right) \
+            + self.padding_symbol * self.padding_right \
+            + self.border_symbol
+
+    def _blank_line(self):
+        return self.border_symbol \
+            + self.padding_symbol * self.padding_left \
+            + self.background_symbol * (self.width - 2 - self.padding_left - self.padding_right) \
+            + self.padding_symbol * self.padding_right \
+            + self.border_symbol

simple_terminal_banner/examples.py

@@ -0,0 +1,77 @@
+from simple_terminal_banner import Banner, BannerThemes
+
+# create a simple banner showing the easiest possible
+# way to have a quick and easy banner message displayed
+banner = Banner("Hello, World!")
+banner.display()
+
+# create a banner that also has a title
+titled_banner = Banner("This banner message has a title.")
+titled_banner.title = "Banner with a title"
+titled_banner.display()
+
+# There are some pre-defined themes that can be used
+# to change the look of the banner. Here are examples
+# of all the available themes.
+for index, theme in enumerate(BannerThemes):
+    banner.theme(theme.value)
+    banner.title = f"{index+1}. Theme: {theme.value.capitalize()}"
+    banner.set_message(f"Theme name: {theme.value}")
+    banner.display()
+
+quit()
+
+print(list(BannerThemes))
+for theme in BannerThemes:
+    print(theme.name)
+
+basic_banner = Banner("Hello, World!")
+basic_banner.title = "12345678901234567890123456789012345678901234567890"
+basic_banner.title_padding = 0
+basic_banner.title_margin = 0
+basic_banner.display()
+# quit()
+banner = Banner("1234567890")
+print()
+banner.title = "Simple Terminal Banner"
+banner.width = 40
+banner.padding_left = 4
+banner.padding_right = 4
+banner.set_message("Hello, World!")
+banner.display()
+print()
+
+
+
+multiline_banner = Banner()
+multiline_banner.title = "Multiline Banner"
+multiline_banner.width = 40
+multiline_banner.padding_left = 4
+multiline_banner.padding_right = 4
+multiline_banner.margin_bottom = 1
+multiline_banner.add_row("Hello, World!")
+multiline_banner.add_row(type="blank")
+multiline_banner.add_row("This is a multiline banner.")
+multiline_banner.add_row("It can display multiple lines.")
+multiline_banner.add_row(type="separator")
+multiline_banner.add_row("This is the last line.")
+multiline_banner.display()
+
+no_border_banner = Banner()
+no_border_banner.theme("none")
+no_border_banner.title = "No Border, Margin or Padding, wrapped"
+no_border_banner.width = 40
+no_border_banner.add_row("Hello, World! This is the way you introduce most code examples in tutorials. It came from a book about C in the 1980s, but it's become a meme.")
+no_border_banner.display()
+
+no_border_banner.set_wrap(False)
+no_border_banner.display()
+
+no_padding_banner = Banner()
+no_padding_banner.title = "No Margin or Padding, wrapped text"
+no_padding_banner.width = 40
+no_padding_banner.padding_left = 2
+no_padding_banner.padding_right = 2
+no_padding_banner.margin_bottom = 1
+no_padding_banner.add_row("Hello, World! This is the way you introduce most code examples in tutorials. It came from a book about C in the 1980s, but it's become a meme.")
+no_padding_banner.display()

simple_terminal_banner-0.0.6.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Stephen Graham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

simple_terminal_banner-0.0.6.dist-info/METADATA

@@ -0,0 +1,54 @@
+Metadata-Version: 2.2
+Name: simple_terminal_banner
+Version: 0.0.6
+Summary: A simple Python utility to display banners in the terminal
+Author-email: "Stephen J. Graham" <stephen@seesawweb.com>
+License: MIT
+Project-URL: Homepage, https://github.com/charlbury/simple_terminal_banner
+Project-URL: Repository, https://github.com/charlbury/simple_terminal_banner
+Project-URL: Issues, https://github.com/charlbury/simple_terminal_banner/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# Simple Terminal Banner
+
+```
+** Simple Terminal Banner **************
+*                                      *
+*    Hello, World!                     *
+*                                      *
+****************************************
+```
+
+Display a simple terminal banner.
+
+## Features
+
+* Banner Title
+* Themes
+* Padding
+* Configurable border symbols
+* Configurable background symbols
+
+## Example
+
+```python
+from banner import Banner
+
+banner = Banner("Hello, World!")
+banner.display()
+```
+
+Produces:
+
+```
+****************************************
+*                                      *
+* Hello, World!                        *
+*                                      *
+****************************************
+```

simple_terminal_banner-0.0.6.dist-info/RECORD

@@ -0,0 +1,8 @@
+simple_terminal_banner/__init__.py,sha256=0cfNpfswT8T3vW4vLg8xTX3VaYMLUshLevSRd3ogUFQ,40
+simple_terminal_banner/banner.py,sha256=vmjpqRe66wANTNlOyb4gm9JIei52MvYwGMacjycyul0,7271
+simple_terminal_banner/examples.py,sha256=EmLE5DVBc0poF8hdNMSuefw-aWtNKdQ8v8w9QTbCGAA,2602
+simple_terminal_banner-0.0.6.dist-info/LICENSE,sha256=zK9pX0Av9b6gWXqXxUlfXuHZv8EyFyZJJwRh-lwlJIM,1071
+simple_terminal_banner-0.0.6.dist-info/METADATA,sha256=ag8bbg-Y0xy_9nOeioIHcppKgUgNx42nRYhAiagnB_s,1384
+simple_terminal_banner-0.0.6.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+simple_terminal_banner-0.0.6.dist-info/top_level.txt,sha256=AUlEwZU8ureUzl5SFLPaAYNd4wbOwYgAl4nErx2rjKs,23
+simple_terminal_banner-0.0.6.dist-info/RECORD,,

simple_terminal_banner-0.0.6.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

simple_terminal_banner-0.0.6.dist-info/top_level.txt

@@ -0,0 +1 @@
+simple_terminal_banner