xulbux 1.7.2__py3-none-any.whl → 1.8.0__py3-none-any.whl

xulbux/_consts_.py

@@ -1,180 +0,0 @@
-from dataclasses import dataclass
-from typing import TypeAlias
-
-
-FormattableString: TypeAlias = str
-"""A `str` object that is made to be formatted with the `.format()` method."""
-
-
-@dataclass
-class COLOR:
-    """Color presets used in the `xulbux` library."""
-
-    text = "#A5D6FF"
-    """The default text color used in the `xulbux` library."""
-
-    white = "#F1F2FF"
-    lightgray = "#B6B7C0"
-    gray = "#7B7C8D"
-    darkgray = "#67686C"
-    black = "#202125"
-    red = "#FF606A"
-    coral = "#FF7069"
-    orange = "#FF876A"
-    tangerine = "#FF9962"
-    gold = "#FFAF60"
-    yellow = "#FFD260"
-    lime = "#C9F16E"
-    green = "#7EE787"
-    neongreen = "#4CFF85"
-    teal = "#50EAAF"
-    cyan = "#3EDEE6"
-    ice = "#77DBEF"
-    lightblue = "#60AAFF"
-    blue = "#8085FF"
-    lavender = "#9B7DFF"
-    purple = "#AD68FF"
-    magenta = "#C860FF"
-    pink = "#F162EF"
-    rose = "#FF609F"
-
-
-class _AllTextCharacters:
-    pass
-
-
-@dataclass
-class CHARS:
-    """Text character sets."""
-
-    all = _AllTextCharacters
-    """Code to signal that all characters are allowed."""
-
-    digits: str = "0123456789"
-    """Digits: `0`-`9`"""
-    float_digits: str = digits + "."
-    """Digits: `0`-`9` with decimal point `.`"""
-    hex_digits: str = digits + "#abcdefABCDEF"
-    """Digits: `0`-`9` Letters: `a`-`f` `A`-`F` and a hashtag `#`"""
-
-    lowercase: str = "abcdefghijklmnopqrstuvwxyz"
-    """Lowercase letters `a`-`z`"""
-    lowercase_extended: str = lowercase + "äëïöüÿàèìòùáéíóúýâêîôûãñõåæç"
-    """Lowercase letters `a`-`z` with all lowercase diacritic letters."""
-    uppercase: str = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
-    """Uppercase letters `A`-`Z`"""
-    uppercase_extended: str = uppercase + "ÄËÏÖÜÀÈÌÒÙÁÉÍÓÚÝÂÊÎÔÛÃÑÕÅÆÇß"
-    """Uppercase letters `A`-`Z` with all uppercase diacritic letters."""
-
-    letters: str = lowercase + uppercase
-    """Lowercase and uppercase letters `a`-`z` and `A`-`Z`"""
-    letters_extended: str = lowercase_extended + uppercase_extended
-    """Lowercase and uppercase letters `a`-`z` `A`-`Z` and all diacritic letters."""
-
-    special_ascii: str = " !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
-    """All ASCII special characters."""
-    special_ascii_extended: str = special_ascii + "ø£Ø׃ªº¿®¬½¼¡«»░▒▓│┤©╣║╗╝¢¥┐└┴┬├─┼╚╔╩╦╠═╬¤ðÐı┘┌█▄¦▀µþÞ¯´≡­±‗¾¶§÷¸°¨·¹³²■ "
-    """All ASCII special characters with the extended ASCII special characters."""
-    standard_ascii: str = special_ascii + digits + letters
-    """All standard ASCII characters."""
-    full_ascii: str = special_ascii_extended + digits + letters_extended
-    """All characters in the ASCII table."""
-
-
-class ANSI:
-    """Constants and class-methods for use of ANSI escape codes."""
-
-    escaped_char: str = "\\x1b"
-    """The printable ANSI escape character."""
-    CHAR = char = "\x1b"
-    """The ANSI escape character."""
-    START = start = "["
-    """The start of an ANSI escape sequence."""
-    SEP = sep = ";"
-    """The separator between ANSI escape sequence parts."""
-    END = end = "m"
-    """The end of an ANSI escape sequence."""
-
-    @classmethod
-    def seq(cls, parts: int = 1) -> FormattableString:
-        """Generate an ANSI sequence with `parts` amount of placeholders."""
-        return cls.CHAR + cls.START + cls.SEP.join(["{}" for _ in range(parts)]) + cls.END
-
-    seq_color: FormattableString = CHAR + START + "38" + SEP + "2" + SEP + "{}" + SEP + "{}" + SEP + "{}" + END
-    """The ANSI escape sequence for setting the text RGB color."""
-    seq_bg_color: FormattableString = CHAR + START + "48" + SEP + "2" + SEP + "{}" + SEP + "{}" + SEP + "{}" + END
-    """The ANSI escape sequence for setting the background RGB color."""
-
-    color_map: tuple[str, ...] = (
-        ########### DEFAULT CONSOLE COLOR NAMES ############
-        "black",
-        "red",
-        "green",
-        "yellow",
-        "blue",
-        "magenta",
-        "cyan",
-        "white",
-    )
-    """The console default color names."""
-
-    codes_map: dict[str | tuple[str, ...], int] = {
-        ################# SPECIFIC RESETS ##################
-        "_": 0,
-        ("_bold", "_b"): 22,
-        ("_dim", "_d"): 22,
-        ("_italic", "_i"): 23,
-        ("_underline", "_u"): 24,
-        ("_double-underline", "_du"): 24,
-        ("_inverse", "_invert", "_in"): 27,
-        ("_hidden", "_hide", "_h"): 28,
-        ("_strikethrough", "_s"): 29,
-        ("_color", "_c"): 39,
-        ("_background", "_bg"): 49,
-        ################### TEXT STYLES ####################
-        ("bold", "b"): 1,
-        ("dim", "d"): 2,
-        ("italic", "i"): 3,
-        ("underline", "u"): 4,
-        ("inverse", "invert", "in"): 7,
-        ("hidden", "hide", "h"): 8,
-        ("strikethrough", "s"): 9,
-        ("double-underline", "du"): 21,
-        ################## DEFAULT COLORS ##################
-        "black": 30,
-        "red": 31,
-        "green": 32,
-        "yellow": 33,
-        "blue": 34,
-        "magenta": 35,
-        "cyan": 36,
-        "white": 37,
-        ############## BRIGHT DEFAULT COLORS ###############
-        "br:black": 90,
-        "br:red": 91,
-        "br:green": 92,
-        "br:yellow": 93,
-        "br:blue": 94,
-        "br:magenta": 95,
-        "br:cyan": 96,
-        "br:white": 97,
-        ############ DEFAULT BACKGROUND COLORS #############
-        "bg:black": 40,
-        "bg:red": 41,
-        "bg:green": 42,
-        "bg:yellow": 43,
-        "bg:blue": 44,
-        "bg:magenta": 45,
-        "bg:cyan": 46,
-        "bg:white": 47,
-        ######### BRIGHT DEFAULT BACKGROUND COLORS #########
-        "bg:br:black": 100,
-        "bg:br:red": 101,
-        "bg:br:green": 102,
-        "bg:br:yellow": 103,
-        "bg:br:blue": 104,
-        "bg:br:magenta": 105,
-        "bg:br:cyan": 106,
-        "bg:br:white": 107,
-    }
-    """All custom format keys and their corresponding ANSI format number codes."""

xulbux-1.7.2.dist-info/METADATA

@@ -1,170 +0,0 @@
-Metadata-Version: 2.4
-Name: xulbux
-Version: 1.7.2
-Summary: A Python library which includes lots of helpful classes, types and functions aiming to make common programming tasks simpler.
-Author-email: XulbuX <xulbux.real@gmail.com>
-License-Expression: MIT
-Project-URL: Bug Reports, https://github.com/XulbuX/PythonLibraryXulbuX/issues
-Project-URL: Changelog, https://github.com/XulbuX/PythonLibraryXulbuX/blob/main/CHANGELOG.md
-Project-URL: Documentation, https://github.com/XulbuX/PythonLibraryXulbuX/wiki
-Project-URL: Homepage, https://github.com/XulbuX/PythonLibraryXulbuX
-Project-URL: License, https://github.com/XulbuX/PythonLibraryXulbuX/blob/main/LICENSE
-Project-URL: Source Code, https://github.com/XulbuX/PythonLibraryXulbuX/tree/main/src
-Keywords: args,arguments,attributes,classes,cmd,client,code,codes,color,commands,console,consts,constants,convert,conversion,data,debug,easier,env,environment,error,file,format,formatting,functions,helper,hex,hexa,hsl,hsla,info,input,json,library,log,logging,methods,nice,operations,path,presets,pretty,printing,properties,python,re,regex,rgb,rgba,string,structures,system,tools,types,utility,warn,warning,xulbux
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.10.0
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: keyboard>=0.13.5
-Requires-Dist: mouse>=0.7.1
-Requires-Dist: prompt_toolkit>=3.0.41
-Requires-Dist: pyperclip>=1.9.0
-Requires-Dist: regex>=2023.10.3
-Provides-Extra: dev
-Requires-Dist: pytest>=7.4.2; extra == "dev"
-Requires-Dist: black>=23.7.0; extra == "dev"
-Requires-Dist: isort>=5.12.0; extra == "dev"
-Requires-Dist: flake8>=6.1.0; extra == "dev"
-Requires-Dist: flake8-pyproject>=1.2.3; extra == "dev"
-Dynamic: license-file
-
-# **$\Huge\textsf{XulbuX}$**
-
-**XulbuX** is library that contains many useful classes, types, and functions,
-ranging from console logging and working with colors to file management and system operations.
-The library is designed to simplify common programming tasks and improve code readability through its collection of tools.
-
-For precise information about the library, see the library's [**wiki page**](https://github.com/XulbuX/PythonLibraryXulbuX/wiki).<br>
-For the libraries latest changes and updates, see the [**change log**](https://github.com/XulbuX/PythonLibraryXulbuX/blob/main/CHANGELOG.md).
-
-<br>
-
-## Installation
-
-Run the following commands in a console with administrator privileges, so the actions take effect for all users.
-
-Install the library and all its dependencies with the command:
-```console
-pip install xulbux
-```
-
-Upgrade the library and all its dependencies to their latest available version with the command:
-```console
-pip install --upgrade xulbux
-```
-
-<br>
-
-## Usage
-
-Import the full library under the alias `xx`, so its constants, classes, methods and types are accessible with `xx.CONSTANT.value`, `xx.Class.method()`, `xx.type()`:
-```python
-import xulbux as xx
-```
-So you don't have to import the full library under an alias, you can also import only certain parts of the library's contents:
-```python
-# CONSTANTS
-from xulbux import COLOR, CHARS, ANSI
-# Classes
-from xulbux import Code, Color, Console, ...
-# types
-from xulbux import rgba, hsla, hexa
-```
-
-<br>
-
-## Modules
-
-| Module                                                                                                                                                     | Short Description                                                                                  |
-| :--------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------- |
-| [![xx_code](https://img.shields.io/badge/xx__code-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_code)                          | advanced code-string operations (*changing the indent, finding function calls, ...*)               |
-| [![xx_color](https://img.shields.io/badge/xx__color-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_color)                       | everything around colors (*converting, blending, searching colors in strings, ...*)                |
-| [![xx_console](https://img.shields.io/badge/xx__console-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_console)                 | advanced actions related to the console (*pretty logging, advanced inputs, ...*)                   |
-| [![xx_data](https://img.shields.io/badge/xx__data-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_data)                          | advanced operations with data structures (*compare, generate path ID's, pretty print/format, ...*) |
-| [![xx_env_path](https://img.shields.io/badge/xx__env__path-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_env_path)             | getting and editing the PATH variable (*get paths, check for paths, add paths, ...*)               |
-| [![xx_file](https://img.shields.io/badge/xx__file-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_file)                          | advanced working with files (*create files, rename file-extensions, ...*)                          |
-| [![xx_format_codes](https://img.shields.io/badge/xx__format__codes-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_format_codes) | easy pretty printing with custom format codes (*print, inputs, custom format codes to ANSI, ...*)  |
-| [![xx_json](https://img.shields.io/badge/xx__json-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_json)                          | advanced working with json files (*read, create, update, ...*)                                     |
-| [![xx_path](https://img.shields.io/badge/xx__path-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_path)                          | advanced path operations (*get paths, smart-extend relative paths, delete paths, ...*)             |
-| ![xx_regex](https://img.shields.io/badge/xx__regex-6065FF?style=flat)                                                                                      | generated regex pattern-templates (*match bracket- and quote pairs, match colors, ...*)            |
-| [![xx_string](https://img.shields.io/badge/xx__string-6065FF?style=flat)](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_string)                    | helpful actions when working with strings. (*normalize, escape, decompose, ...*)                   |
-| ![xx_system](https://img.shields.io/badge/xx__system-6065FF?style=flat)                                                                                    | advanced system actions (*restart with message, check installed Python libs, ...*)                 |
-
-<br>
-
-## Example Usage
-
-This is what it could look like using this library for a simple but very nice looking color converter:
-```python
-from xulbux import COLOR                 # CONSTANTS
-from xulbux import FormatCodes, Console  # Classes
-from xulbux import hexa                  # types
-
-
-def main() -> None:
-
-    # LET THE USER ENTER A HEXA COLOR IN ANY HEXA FORMAT
-    input_clr = FormatCodes.input(
-        "\n[b](Enter a HEXA color in any format) [dim](>) "
-    )
-
-    # ANNOUNCE INDEXING THE INPUT COLOR
-    Console.log(
-        "INDEX",
-        "Indexing the input HEXA color...",
-        start="\n",
-        title_bg_color=COLOR.blue,
-    )
-
-    try:
-        # TRY TO CONVERT THE INPUT COLOR INTO A hexa() COLOR
-        hexa_color = hexa(input_clr)
-
-    except ValueError:
-        # ANNOUNCE THE ERROR AND EXIT THE PROGRAM
-        Console.fail(
-            "The input HEXA color is invalid.",
-            end="\n\n",
-            exit=True,
-        )
-
-    # ANNOUNCE STARTING THE CONVERSION
-    Console.log(
-        "CONVERT",
-        "Converting the HEXA color into different types...",
-        title_bg_color=COLOR.tangerine,
-    )
-
-    # CONVERT THE HEXA COLOR INTO THE TWO OTHER COLOR TYPES
-    rgba_color = hexa_color.to_rgba()
-    hsla_color = hexa_color.to_hsla()
-
-    # ANNOUNCE THE SUCCESSFUL CONVERSION
-    Console.done(
-        "Successfully converted color into different types.",
-        end="\n\n",
-    )
-
-    # PRETTY PRINT THE COLOR IN DIFFERENT TYPES
-    Console.log_box_bordered(
-        f"[b](HEXA:) [i|white]({hexa_color})",
-        f"[b](RGBA:) [i|white]({rgba_color})",
-        f"[b](HSLA:) [i|white]({hsla_color})",
-    )
-
-
-if __name__ == "__main__":
-    main()
-```
-
-<br>
-<br>
-
---------------------------------------------------------------
-[View this library on **PyPI**](https://pypi.org/project/XulbuX/)

xulbux-1.7.2.dist-info/RECORD

@@ -1,21 +0,0 @@
-xulbux/__init__.py,sha256=vd8y5L0AwqnxqXm_IAJ5grbfm8ZkcSHJx36n1KUQTlc,815
-xulbux/_cli_.py,sha256=J4vfJHLJEYxCZzA_VJUB46w2WGShfdYFoetsLG5PfKo,3428
-xulbux/_consts_.py,sha256=4CLJE-YH3si2YQ-IHcjsT5PW0D7vGvm8ZH13rUoG5cE,6166
-xulbux/xx_code.py,sha256=b8MJId-BmZOsBH38z-h055op7qIICdsTT3rFJ7SWkiE,6111
-xulbux/xx_color.py,sha256=Thj7fFTc8x-VmYyULI3HQW0uCk9dIihwrGUwuXGn83s,49744
-xulbux/xx_console.py,sha256=c61EXVGQo_OL_MUWb4oXbIr6EKesm1v-FwxBIe47ZTg,34866
-xulbux/xx_data.py,sha256=nEfVwK6-ILaL3K-bLezKpG1G7117CY5ZgC3BGwANrUE,30886
-xulbux/xx_env_path.py,sha256=x56mKK4lSvU5yMCAs8k0RVIqXWUJcpcHYz5HoZ_RklM,4160
-xulbux/xx_file.py,sha256=KerXOvKS93zIoAt36YTYuZboSmxVFVf2WcOrDcdwXfE,2627
-xulbux/xx_format_codes.py,sha256=-tSsgy1tRelmU5x5ZS7ujaiXntyRqk1sm759tyvVIyU,24698
-xulbux/xx_json.py,sha256=V7vdfpvSe9wpktR_c8zG_Meix7x9IRmn66k5nB3HUyo,7457
-xulbux/xx_path.py,sha256=lLAEVZrW0TAwCewlONFVQcQ_8tVn9LTJZVOZpeGvE5s,7673
-xulbux/xx_regex.py,sha256=_BtMHRDNcD9zF4SL87dQuUVZcYGfZx9H5YNSDiEtzm8,8059
-xulbux/xx_string.py,sha256=QaTo0TQ9m_2USNgQNaVw5ivQt-A1E-e5x8OpIB3xIlY,5561
-xulbux/xx_system.py,sha256=Tsx4wgztUg46KloqcGeiFkarDoM3EgJLXw3XNxgHBmU,6460
-xulbux-1.7.2.dist-info/licenses/LICENSE,sha256=6NflEcvzFEe8_JFVNCPVwZBwBhlLLd4vqQi8WiX_Xk4,1084
-xulbux-1.7.2.dist-info/METADATA,sha256=vlIkVkj97ZLjiFajkGrSZ5O0GDrzuIunJ1E1iqY-QTA,9209
-xulbux-1.7.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-xulbux-1.7.2.dist-info/entry_points.txt,sha256=a3womfLIMZKnOFiyy-xnVb4g2qkZsHR5FbKKkljcGns,94
-xulbux-1.7.2.dist-info/top_level.txt,sha256=FkK4EZajwfP36fnlrPaR98OrEvZpvdEOdW1T5zTj6og,7
-xulbux-1.7.2.dist-info/RECORD,,

xulbux-1.7.2.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-xulbux-help = xulbux._cli_:help_command
-xx-help = xulbux._cli_:help_command

xulbux-1.7.2.dist-info/licenses/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 XulbuX
-
-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.