it's ready for the public

Author: Butterroach

.gitignore

@@ -1 +1,4 @@
 __pycache__
+*.egg-info/
+dist/
+build/

LICENSE

@@ -0,0 +1,45 @@
+# tranci: puts you in a trance.
+
+<img src="screenshot.png" alt="Screenshot of Tranci's __main__.py output.">
+
+## What in the world is a "tranci"?
+
+`tranci` is a no-dependencies, lightweight, easy-to-use, Pythonic ANSI library. It officially supports Python 3.9-3.13. You can move the cursor around, do some colors. Idk, just general ANSI.
+
+## How do I use this?
+
+Install the `tranci` package with `pip`. Run `python -m tranci` to confirm it works.
+
+Example code:
+
+```py
+import tranci
+
+print(tranci.Red("Red text"))
+print(tranci.BGRed("Red background"))
+print(tranci.RGB(164, 106, 120, "RGB code"))
+print(tranci.HEX("#A44A44", "HEX code"))
+
+weird_cyan_green_color_thing = tranci.HEX(0x3affad)
+
+print(weird_cyan_green_color_thing("You can save them too"))
+```
+
+You can figure out everything else just by looking at your IDE's autocomplete! (or just look at the cool `tranci/__main__.py` source code)
+
+## Why would I use this over anything else
+
+-   Auto reset handling
+-   Actual nesting functionality
+-   IDE auto-complete won't cry seeing the code
+-   True color
+-   Zero dependencies
+
+## Ok but ~~[that one clone of a JS library that shall not be named]~~ exists
+
+-   It's a clone of a JS library. What do you think?
+-   `tranci` has almost everything ~~[that one clone of a JS library that shall not be named]~~ has except fallbacks (and maybe the edge cases though I'm not sure what edge cases they're referring to).
+-   You don't need fallbacks/capabilities-detection. It just adds bloat.
+-   Even if the JS clone is slightly lighter, `tranci` isn't just colors and styles and <font color="red"><u>**_~~oooo look at this bold italic striked underlined red text!!!~~_**</u></font>. It also supports a bit more general ANSI, in a more Pythonic extendable syntax. You can add your own ANSI things to `tranci` with the class system. Plus the world won't end if your project is 51.82KiB larger than it could be.
+
+Download tranci now! or something uhh what do those mobile game ads say at the end again

README.md

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

pyproject.toml

@@ -0,0 +1,27 @@
+from setuptools import setup, find_packages
+from pathlib import Path
+
+setup(
+    name="tranci",
+    version="1.0.0",
+    description="Tranci: a no-dependencies, lightweight, easy-to-use ANSI library",
+    long_description=(Path(__file__).parent / "README.md").read_text(encoding="utf-8"),
+    long_description_content_type="text/markdown",
+    author="Butterroach",
+    author_email="[email protected]",
+    url="https://github.com/Butterroach/tranci",
+    license="LGPLv3+",
+    packages=find_packages(),
+    classifiers=[
+        "Development Status :: 5 - Production/Stable",
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+        "Intended Audience :: Developers",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.9",
+    project_urls={
+        "Source": "https://github.com/Butterroach/tranci",
+        "Bug Tracker": "https://github.com/Butterroach/tranci/issues",
+    },
+)

screenshot.png

@@ -19,6 +19,7 @@
 
 import os
 import sys
+from enum import Enum
 from typing import Union
 
 if sys.platform == "win32":
@@ -46,9 +47,31 @@ def __call__(self, text: str):
         """
         Returns the text provided in the same style. Useful for saving colors and reusing them over and over again.
         """
+
         return BaseText.__new__(BaseText, self.code, text)
 
 
+class Hyperlink(str):
+    """
+    Bet you didn't know this was a thing! Yeah, it's real. Hyperlinks. In a terminal. Crazy. Just be aware that this is not too standard.
+    """
+
+    def __new__(cls, url: str, text: Union[str, BaseText, None] = None):
+        if text is None:
+            return super().__new__(cls)
+        return super().__new__(cls, f"\033]8;;{url}\033\\{text}\033]8;;\033")
+
+    def __init__(self, url: str, text: Union[str, BaseText, None] = None):
+        self.url = url
+
+    def __call__(self, text: str):
+        """
+        Why are you doing this with hyperlinks
+        """
+
+        return Hyperlink.__new__(Hyperlink, self.url, text)
+
+
 class Bold(BaseText):
     def __new__(cls, text: Union[str, BaseText, None] = None):
         code = "\033[1m"
@@ -349,3 +372,74 @@ def __init__(self, hexa: Union[str, int], text: Union[str, BaseText, None] = Non
         if isinstance(hexa, str):
             hexa = int(hexa.replace("#", ""), 16)
         super().__init__((hexa >> 16) & 255, (hexa >> 8) & 255, hexa & 255)
+
+
+class Direction(Enum):
+    UP = "A"
+    DOWN = "B"
+    RIGHT = "C"
+    LEFT = "D"
+
+
+def move_cursor_dir(dir: Direction, lines: int, do_print: bool = True):
+    code = f"\033[{lines}{dir.value}"
+    if do_print:
+        print(code, end="")
+    return code
+
+
+def move_cursor_pos(row: int, col: int, do_print: bool = True):
+    """
+    move_cursor_pos(1, 1) will move the cursor to the top left corner.
+    """
+
+    code = f"\033[{row};{col}H"
+    if do_print:
+        print(code, end="")
+    return code
+
+
+def save_cursor_pos(do_print: bool = True):
+    """
+    Tells the terminal emulator to save the current position for later use during the current session.
+    """
+
+    code = "\033[s"
+    if do_print:
+        print(code, end="")
+    return code
+
+
+def restore_cursor_pos(do_print: bool = True):
+    """
+    Tells the terminal emulator to move the cursor back to the last saved position.
+    """
+
+    code = "\033[u"
+    if do_print:
+        print(code, end="")
+    return code
+
+
+def set_cursor_visibility(visible: bool, do_print: bool = True):
+    if visible:
+        code = "\033[?25h"
+    else:
+        code = "\033[?25l"
+    if do_print:
+        print(code, end="")
+    return code
+
+
+def clear_screen(do_print: bool = True):
+    code = "\033[2K"
+    if do_print:
+        print(code, end="")
+    return code
+
+
+def clear_line(do_print: bool = True):
+    code = "\033[2J"
+    if do_print:
+        print(code, end="")
+    return code

setup.py

@@ -18,67 +18,100 @@
 """
 
 import colorsys
+import os
+import shutil
 import time
 import tranci
+from pathlib import Path
 
+if __name__ == "__main__":
+    try:
+        for hue in range(360):
+            r, g, b = colorsys.hsv_to_rgb(hue / 360, 1, 1)
+            r, g, b = r * 255, g * 255, b * 255
+            print(tranci.RGB(r, g, b, f"tranci"), end="\r")
+            time.sleep(0.01)
+    except KeyboardInterrupt:
+        pass
+
+    FOLLOWUP_1 = ": puts you in a trance."
+    FOLLOWUP_2 = f" v{tranci.__version__} | https://github.com/Butterroach/tranci"
+
+    whitening_followup_1 = []
+    whitening_followup_2 = []
+
+    for i in range(len(FOLLOWUP_1)):
+        _r, _g, _b = colorsys.hsv_to_rgb(hue / 360, 1 - (i + 1) / len(FOLLOWUP_1), 1)
+        _r, _g, _b = _r * 255, _g * 255, _b * 255
+        whitening_followup_1.append(tranci.RGB(_r, _g, _b, FOLLOWUP_1[i]))
+
+    for i in range(len(FOLLOWUP_2)):
+        _r, _g, _b = colorsys.hsv_to_rgb(hue / 360, 1 - (i + 1) / len(FOLLOWUP_2), 1)
+        _r, _g, _b = _r * 255, _g * 255, _b * 255
+        whitening_followup_2.append(tranci.RGB(_r, _g, _b, FOLLOWUP_2[i]))
+
+    try:
+        for i in range(1, len(FOLLOWUP_1)):
+            if i > 1:
+                time.sleep(0.15)
+            print(
+                f"\r{tranci.RGB(r, g, b, 'tranci')}{''.join(whitening_followup_1[:i])}",
+                end="\r",
+            )
+    except KeyboardInterrupt:
+        print(
+            f"\r{tranci.RGB(r, g, b, 'tranci')}{''.join(whitening_followup_1)}",
+            end="\r",
+        )
 
-def main():
-    print(tranci.Red("This is red text"))
-    print(tranci.Green("This is green text"))
-    print(tranci.Blue("This is blue text"))
-
-    print(tranci.BrightRed("This is bright red text"))
-    print(tranci.BrightGreen("This is bright green text"))
-    print(tranci.BrightBlue("This is bright blue text"))
-
-    print(tranci.BGRed("This text has a red background"))
-    print(tranci.BGGreen("This text has a green background"))
-    print(tranci.BGBlue("This text has a blue background"))
+    try:
+        time.sleep(1)
+    except:
+        print(
+            f"\r{tranci.RGB(r, g, b, 'tranci')}{''.join(whitening_followup_1)}",
+            end="\r",
+        )
 
-    print(tranci.BGBrightRed("This text has a bright red background"))
-    print(tranci.BGBrightGreen("This text has a bright green background"))
-    print(tranci.BGBrightBlue("This text has a bright blue background"))
+    print(" " * shutil.get_terminal_size().columns, end="\r")
+    print(f"{tranci.RGB(r, g, b, 'tranci')}{''.join(whitening_followup_2)}\n")
 
-    print(tranci.Bold(tranci.Red("This is bold and red text")))
-    print(tranci.Italicized(tranci.Green("This is italicized and green text")))
-    print(tranci.Underlined(tranci.Blue("This is underlined and blue text")))
+    time.sleep(0.1)
 
     print(
         tranci.Red(
-            f"This is red text, but {tranci.Blue('this is blue')}. And the rest is red"
+            f"This is red text, \nbut {tranci.Blue('this is blue')}. And the rest is red."
         )
     )
 
-    print(tranci.RGB(255, 165, 0, "This is custom RGB color text"))
-    print(tranci.HEX("#AFCBED", "This is custom HEX color text with str"))
-    print(tranci.HEX(0xEFEABD, "This is custom HEX color text with int"))
+    print(tranci.RGB(255, 165, 0, "This is custom RGB text."))
+    print(tranci.HEX("#AFCBED", "This is custom HEX text with str."))
+    print(tranci.HEX(0xEFEABD, "This is custom HEX text with int."))
     print(
         tranci.Bold(
             tranci.Italicized(
                 tranci.Underlined(
                     tranci.BrightMagenta(
-                        "This is bold, italicized, underlined, and bright magenta text"
+                        "This is bold, italicized, underlined, and bright magenta text."
                     )
                 )
             )
         )
     )
 
-    for hue in range(360):
-        r, g, b = colorsys.hsv_to_rgb(hue / 360, 1, 1)
-        r, g, b = r * 255, g * 255, b * 255
-        print(tranci.RGB(r, g, b, f"Rainbow!!"), end="\r")
-        time.sleep(0.005)
-
-    print()
-
     warning = tranci.HEX("#fff374")
 
-    print(warning("This is a warning colored by saving a color and calling it"))
+    print(warning("This is a warning colored by saving a color and calling it."))
     print(warning("Another warning!"))
     print(tranci.Inverted(warning("And that's the inverted one!")))
     print(tranci.BGHEX("#fff374", tranci.HEX(0, "Or if you wanna be real, I suppose.")))
 
+    print(
+        tranci.Hyperlink(
+            "https://rickroll.link",
+            f"...{tranci.Italicized(warning('Hyperlinks'))}? What?",
+        )
+    )
+
+    google = tranci.Hyperlink("https://www.google.com/")
 
-if __name__ == "__main__":
-    main()
+    print(google("This supports saving too, for whatever reason."))