xulbux 1.5.5__tar.gz → 1.5.8__tar.gz

xulbux-1.5.8/.github/workflows/python-package.yml

@@ -0,0 +1,49 @@
+# THIS WORKFLOW WILL INSTALL PYTHON DEPENDENCIES, RUN TESTS AND LINT WITH A VARIETY OF PYTHON VERSIONS
+# FOR MORE INFORMATION SEE: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Cache pip packages
+      uses: actions/cache@v3
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt', '**/pyproject.toml') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+
+    - name: Install project and dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[dev]  # INSTALL PROJECT AND DEV DEPENDENCIES
+        pip install flake8 pytest  # ENSURE BOTH flake8 AND pytest ARE INSTALLED
+
+    - name: Lint with flake8
+      run: |
+        python -m flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        python -m flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+
+    - name: Test with pytest
+      run: |
+        python -m pytest --verbose  # RUN pytest USING PYTHON MODULE TO AVOID PATH ISSUES

xulbux-1.5.8/.gitignore

@@ -0,0 +1,31 @@
+# Python bytecode
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+wheels/
+build/
+dist/
+
+# PyBuilder
+.pybuilder/
+target/
+
+.python-version
+
+# PEP 582
+__pypackages__/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# VS Code
+.vscode/
+
+# Pytest
+.pytest_cache/

{xulbux-1.5.5 → xulbux-1.5.8}/CHANGELOG.md

@@ -7,7 +7,7 @@
       border-radius: 0.2em;
       text-align: center;
       justify-content: center;
-    ">🠫</div>
+    "><span style="display:none">go to bottom </span>🠫</div>
   </abbr></a>
 </div>
 
@@ -15,68 +15,99 @@
 # <br><b>Changelog</b><br>
 
 
-## ... `v1.5.5`
-* Added functions to get the width and height of the console (*in characters and lines*):<br>
+## ... `v1.5.8`
+* renamed the library from `XulbuX` to `xulbux` for better naming conventions
+* added method `String.is_empty()` to check if the string is empty
+* added method `String.escape()` to escape special characters in a string
+* introduced a new test for `xx_data` (*all methods*)
+* added doc-strings to all the methods in `xx_data`
+* made all the methods from `xx_data` work wih all the types of data structures (*`list`, `tuple`, `set`, `frozenset`, `dict`*)
+* renamed the module `xx_cmd` and it's class `Cmd` to `xx_console` and `Console`
+* renamed the module `xx_env_vars` and it's class `EnvVars` to `xx_env_path` and `EnvPath`
+* added method `EnvPath.remove_path()`
+* introduced a new test for `xx_env_vars` (*all methods*)
+* Added a `hexa_str()` preset to the `xx_regex` module
+* introduced a new test for the methods from the `Color` class in `xx_color`
+
+## 15.11.2024 `v1.5.7`
+* change the testing modules to be able to run together with the library `pytest`
+* added formatting checks, using `black`, `isort` and `flake8`
+* added the script (*command*) `xx-help` or `xulbux-help`
+* moved the `help()` function to the file `_cli_.py`, because that's where all the scripts are located (*It also was renamed to* `help_command()`)
+* structured `Cmd.restricted_input()` a bit nicer, so it appears less complex
+* corrected code after `Lint with flake8` formatting suggestions
+* moved the method `normalize_spaces()` to `xx_string`
+* added additional tests for the custom color types
+* updated the whole `xx_format_codes` module for more efficiency and speed
+
+## 11.11.2024 `v1.5.6`
+* moved the whole library to it's own repository: [PythonLibraryXulbuX](https://github.com/XulbuX-dev/PythonLibraryXulbuX)
+* updated all connections and links
+
+## 11.11.2024 `v1.5.5`
+* added methods to get the width and height of the console (*in characters and lines*):<br>
   <code>Cmd.w() -> *int*</code> how many text characters the console is wide<br>
   <code>Cmd.h() -> *int*</code> how many lines the console is high<br>
   <code>Cmd.wh() -> *tuple[int,int]*</code> a tuple with width and height
-* Added the function <code>split_every_chars(*string*, *split_every*) -> *list*[*str*]</code> to `xx_string`
-* Added doc-strings to every function in `xx_string`
-* Updated the `Cmd.restricted_input()` function:
+* added the method <code>split_count(*string*, *count*) -> *list*[*str*]</code> to `xx_string`
+* added doc-strings to every method in `xx_string`
+* updated the `Cmd.restricted_input()` method:
   - paste text from the clipboard
   - select all text to delete everything at once
   - write and backspace over multiple lines
-* Added required non-standard libraries to the project file
-* Added more metadata to the project file
+  - not the prompt supports custom format codes
+* added required non-standard libraries to the project file
+* added more metadata to the project file
 
 ## 06.11.2024 `v1.5.4`
-* Made the `blend()` method from all the color types modify the *`self`* object as well as returning the result
-* Added a new function <code>normalize_spaces(*code*) -> *str*</code> to `Code`
-* Added new doc-strings to `xx_code` and `xx_cmd`
-* Added a custom `input()` function to `Cmd`, which lets you specify the allowed text characters the user can type, as well as the minimum and maximum length of the input
-* Added the function `pwd_input()` to `Cmd`, which works just like the `Cmd.restricted_input()` but masks the input characters with `*`
-* Restructured the whole library's imports, so you the custom types won't get displayed as `Any` when hovering over a function
-* Fixed bug when trying to get the base directory from a compiled script (*EXE*):<br>
-  Would get the path to the temporary extracted directory, which is created when running the EXE file<br>
-  Now it gets the actual base directory of the currently running file
+* made the `blend()` method from all the color types modify the *`self`* object as well as returning the result
+* added a new method <code>normalize_spaces(*code*) -> *str*</code> to `Code`
+* added new doc-strings to `xx_code` and `xx_cmd`
+* added a custom `input()` method to `Cmd`, which lets you specify the allowed text characters the user can type, as well as the minimum and maximum length of the input
+* added the method `pwd_input()` to `Cmd`, which works just like the `Cmd.restricted_input()` but masks the input characters with `*`
+* restructured the whole library's imports, so you the custom types won't get displayed as `Any` when hovering over a method/function
+* fixed bug when trying to get the base directory from a compiled script (*EXE*):<br>
+  would get the path to the temporary extracted directory, which is created when running the EXE file<br>
+  now it gets the actual base directory of the currently running file
 
 ## 30.10.2024 `v1.5.3`
-* Restructured the values in `_consts_.py`
-* Added the default text color to the `_consts_.py` so it's easier to change it (*and used it in the library*)
-* Added a bunch of other default colors to the `_consts_.py` (*and used them in the library*)
-* Refactored the whole library's code after the [`PEPs`](https://peps.python.org/) and [`The Zen of Python`](https://peps.python.org/pep-0020/#the-zen-of-python) 🫡:
+* restructured the values in `_consts_.py`
+* added the default text color to the `_consts_.py` so it's easier to change it (*and used it in the library*)
+* added a bunch of other default colors to the `_consts_.py` (*and used them in the library*)
+* refactored the whole library's code after the [`PEPs`](https://peps.python.org/) and [`The Zen of Python`](https://peps.python.org/pep-0020/#the-zen-of-python) 🫡:
   - changed the indent to 4 spaces
   - no more inline control statements (*except its only a really small statement and body*)
-* Added new methods to `Color`:<br>
+* added new methods to `Color`:<br>
   <code>rgba_to_hex(*r*, *g*, *b*, *a*) -> *int*</code><br>
   <code>hex_to_rgba(*hex_int*) -> *tuple*</code><br>
   <code>luminance(*r*, *g*, *b*, *precision*, *round_to*) -> *float*|*int*</code>
-* Fixed the `grayscale()` method of `rgba()`, `hsla()` and `hexa()`:<br>
-  The method would previously just return the color, fully desaturated (*not grayscale*)<br>
-  Now this is fixed, and the method uses the luminance formula, to get the actual grayscale value
-* All the methods in the `xx_color` module now support HEXA integers (*e.g.* `0x8085FF` *instead of only strings:* `"#8085FF"` `"0x8085FF"`)
+* fixed the `grayscale()` method of `rgba()`, `hsla()` and `hexa()`:<br>
+  the method would previously just return the color, fully desaturated (*not grayscale*)<br>
+  now this is fixed, and the method uses the luminance formula, to get the actual grayscale value
+* all the methods in the `xx_color` module now support HEXA integers (*e.g.* `0x8085FF` *instead of only strings:* `"#8085FF"` `"0x8085FF"`)
 
 ## 28.10.2024 `v1.5.2`
-* New parameter <code>correct_path:*bool*</code> in `Path.extend()`:
-  This makes sure, that typos in the path will only be corrected if this parameter is set to `True`
-* Fixed bug in `Path.extend()`, where an empty string was taken as a valid path for the current directory `./`
-* Fixed color validation bug:
-  `Color.is_valid_rgba()`and `Color.is_valid_hsla()` would not accept an alpha channel of `None`
+* new parameter <code>correct_path:*bool*</code> in `Path.extend()`:
+  this makes sure, that typos in the path will only be corrected if this parameter is set to `True`
+* fFixed bug in `Path.extend()`, where an empty string was taken as a valid path for the current directory `./`
+* fixed color validation bug:<br>
+  `Color.is_valid_rgba()`and `Color.is_valid_hsla()` would not accept an alpha channel of `None`<br>
   `Color.is_valid_rgba()` was still checking for an alpha channel from `0` to `255` instead of `0` to `1`
-* Fixed bug for `Color.has_alpha()`:
-  Previously, it would return `True` if the alpha channel was `None`. Now in such cases it will return `False`.
+* fixed bug for `Color.has_alpha()`:<br>
+  previously, it would return `True` if the alpha channel was `None`<br>
+  now in such cases it will return `False`
 
 ## 28.10.2024 `v1.5.1`
-* Renamed all library files for a better naming convention
-* Now all functions in `xx_color` support both HEX prefixes (`#` *and* `0x`)
-* Added the default HEX prefix to `_consts_.py`
-* Fixed bug when initializing a `hexa()` object:<br>
-  Would throw an error, even if the color was valid
+* renamed all library files for a better naming convention
+* now all methods in `xx_color` support both HEX prefixes (`#` *and* `0x`)
+* added the default HEX prefix to `_consts_.py`
+* fixed bug when initializing a `hexa()` object:<br>
+  would throw an error, even if the color was valid
 
 ## 27.10.2024 `v1.5.0`
-* Split all classes into separate files, so users can download only parts of the library more easily
-* Added a `__help__.py` file, which will show some information about the library and how to use it, when it's run as a script or when the `help()` function is called
-* Added a lot more metadata to the library:<br>
+* split all classes into separate files, so users can download only parts of the library more easily
+* added a `__help__.py` file, which will show some information about the library and how to use it, when it's run as a script or when the `help()` function is called
+* added a lot more metadata to the library:<br>
   `__version__` (*was already added in update [v1.4.2](#update-1-4-2)*)<br>
   `__author__`<br>
   `__email__`<br>
@@ -88,22 +119,22 @@
 
 ## <span id="update-1-4-2">27.10.2024 `v1.4.2` `v1.4.3`</span>
 * <code>Path.extend(*rel_path*) -> *abs_path*</code> now also extends system variables like `%USERPROFILE%` and `%APPDATA%`
-* Removed unnecessary parts when checking for missing required libraries
-* You can now get the libraries current version by accessing the attribute `XulbuX.__version__`
+* removed unnecessary parts when checking for missing required libraries
+* you can now get the libraries current version by accessing the attribute `XulbuX.__version__`
 
 ## 26.10.2024 `v1.4.1`
-* Added methods to each color type:<br>
+* added methods to each color type:<br>
   <code>is_grayscale() -> *self*</code><br>
   <code>is_opaque() -> *self*</code>
-* Added additional error checking to the color types
-* Made error messages for the color types clearer
-* Updated the <code>blend(*other*, *ratio*)</code> method of all color types to use additive blending except for the alpha-channel
-* Fixed problem with method-chaining for all color types
+* added additional error checking to the color types
+* made error messages for the color types clearer
+* updated the <code>blend(*other*, *ratio*)</code> method of all color types to use additive blending except for the alpha-channel
+* fixed problem with method-chaining for all color types
 
 ## 25.10.2024 `v1.4.0`
-* Huge update to the custom color types:
-  - Now all type-methods support chaining
-  - Added new methods to each type:<br>
+* huge update to the custom color types:
+  - now all type-methods support chaining
+  - added new methods to each type:<br>
     <code>lighten(*amount*) -> *self*</code><br>
     <code>darken(*amount*) -> *self*</code><br>
     <code>saturate(*amount*) -> *self*</code><br>
@@ -118,7 +149,7 @@
     <code>complementary() -> *self*</code>
 
 ## 23.10.2024 `v1.3.1`
-* Now rounds the alpha channel to maximal 2 decimals, if converting from `hexa()` to `rgba()` or `hsla()` 
+* now rounds the alpha channel to maximal 2 decimals, if converting from `hexa()` to `rgba()` or `hsla()` 
 
 ## 21.10.2024 `v1.3.0`
 * fixed the custom types `rgba()`, `hsla()` and `hexa()`:<br>
@@ -131,12 +162,12 @@
   - `hexa()`:<br>
     the method `to_rgba()` works correctly now<br>
     the method `to_hsla()` works correctly now
-* fixed functions from the `Color` class:<br>
+* fixed methods from the `Color` class:<br>
   `Color.has_alpha()` works correctly now<br>
   `Color.to_rgba()` works correctly now<br>
   `Color.to_hsla()` works correctly now<br>
   `Color.to_hexa()` works correctly now
-* set default value for param `allow_alpha:bool` to `True` for functions:<br>
+* set default value for param `allow_alpha:bool` to `True` for methods:<br>
   `Color.is_valid_rgba()`, `Color.is_valid_hsla()`, `Color.is_valid_hexa()`, `Color.is_valid()`
 
 ## 18.10.2024 `v1.2.4` `v1.2.5`
@@ -151,28 +182,28 @@
 * `README.md` improvements
 
 ## 18.10.2024 `v1.2.1` `v1.2.2`
-* fixed bug in function <code>Path.get(*base_dir*=True)</code>:<br>
+* fixed bug in method <code>Path.get(*base_dir*=True)</code>:<br>
   Previously, setting `base_dir` to `True` would not return the actual base directory or even cause an error.<br>
   This was now fixed, and setting `base_dir` to `True` will return the actual base directory of the current program (*except if not running from a file*).
 
 ## 17.10.2024 `v1.2.0`
-* new function in the `Path` class: `Path.remove()`
+* new method in the `Path` class: `Path.remove()`
 
 ## 17.10.2024 `v1.1.9`
 * corrected the naming of classes to comply with Python naming standards
 
 ## 17.10.2024 `v1.1.8`
-* added support for all OSes to the OS-dependent functions
+* added support for all OSes to the OS-dependent methods
 
 ## 17.10.2024 `v1.1.6` `v1.1.7`
-* fixed the `Cmd.cls()` function:<br>
+* fixed the `Cmd.cls()` method:<br>
   There was a bug where, on Windows 10, the ANSI formats weren't cleared.
 
 ## 17.10.2024 `v1.1.4` `v1.1.5`
 * added link to `CHANGELOG.md` to the `README.md` file
 
 ## 17.10.2024 `v1.1.3`
-* changed the default value of the param `compactness:int` in the function `Data.print()` to `1` instead of `0`
+* changed the default value of the param `compactness:int` in the method `Data.print()` to `1` instead of `0`
 
 ## 17.10.2024 `v1.1.1` `v1.1.2`
 * adjusted the library's description
@@ -194,7 +225,7 @@
   prints:  <code><u>(Automatically resetting) following text</u></code>
 
 ## 16.10.2024 `v1.0.7` `v1.0.8`
-* added `input()` function to the `FormatCodes` class, so you can make pretty looking input prompts
+* added `input()` method to the `FormatCodes` class, so you can make pretty looking input prompts
 * added warning for no network connection when trying to [install missing libraries](#improved-lib-importing)
 
 ## 15.10.2024 `v1.0.6`
@@ -282,6 +313,6 @@ from XulbuX import rgb, hsl, hexa
       border-radius: 0.2em;
       text-align: center;
       justify-content: center;
-    ">🠩</div>
+    "><span style="display:none">go to top </span>🠩</div>
   </abbr></a>
 </div>

{xulbux-1.5.5 → xulbux-1.5.8}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.3
-Name: XulbuX
-Version: 1.5.5
+Name: xulbux
+Version: 1.5.8
 Summary: A library which includes a lot of really helpful functions.
-Project-URL: Homepage, https://github.com/XulbuX-dev/Python/tree/main/Libraries/XulbuX
-Project-URL: Bug Reports, https://github.com/XulbuX-dev/Python/issues
-Project-URL: Documentation, https://github.com/XulbuX-dev/Python/wiki
-Project-URL: Source Code, https://github.com/XulbuX-dev/Python/tree/main/Libraries/XulbuX/src
-Project-URL: Changelog, https://github.com/XulbuX-dev/Python/blob/main/Libraries/XulbuX/CHANGELOG.md
+Project-URL: Homepage, https://github.com/XulbuX-dev/PythonLibraryXulbuX
+Project-URL: Bug Reports, https://github.com/XulbuX-dev/PythonLibraryXulbuX/issues
+Project-URL: Documentation, https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki
+Project-URL: Source Code, https://github.com/XulbuX-dev/PythonLibraryXulbuX/tree/main/src
+Project-URL: Changelog, https://github.com/XulbuX-dev/PythonLibraryXulbuX/blob/main/CHANGELOG.md
 Author-email: XulbuX <xulbux.real@gmail.com>
 License: MIT License
         
@@ -29,7 +29,7 @@ License: MIT License
         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.
-Keywords: classes,cmd,code,color,data,env,environment,file,format,functions,helper,helpful,json,library,methods,operations,path,presets,python,regex,string,structures,system,tools,types,utility,xulbux
+Keywords: classes,cmd,code,color,data,env,environment,file,format,functions,helper,json,library,methods,operations,path,presets,python,regex,string,structures,system,tools,types,utility,xulbux
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
@@ -41,24 +41,28 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10.0
 Requires-Dist: keyboard>=0.13.5
 Requires-Dist: mouse>=0.7.1
+Requires-Dist: pyperclip>=1.9.0
 Requires-Dist: regex>=2023.10.3
 Provides-Extra: dev
-Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: black>=23.7.0; extra == 'dev'
+Requires-Dist: flake8>=6.1.0; extra == 'dev'
+Requires-Dist: isort>=5.12.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.2; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # **$\color{#8085FF}\Huge\textsf{XulbuX}$**
 
 **$\color{#8085FF}\textsf{XulbuX}$** is a library which includes a lot of really helpful classes, types and functions.
 
-For the libraries latest changes, see the [change log](https://github.com/XulbuX-dev/Python/blob/main/Libraries/XulbuX/CHANGELOG.md).<br>
-For precise information about the library, see the library's [Wiki page](https://github.com/XulbuX-dev/Python/wiki).
+For the libraries latest changes, see the [change log](https://github.com/XulbuX-dev/PythonLibraryXulbuX/blob/main/CHANGELOG.md).<br>
+For precise information about the library, see the library's [Wiki page](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki).
 
 
 ## Installation
 
 On all operating systems, run the following command:
 ```bash
-pip install XulbuX
+pip install xulbux
 ```
 
 
@@ -66,9 +70,9 @@ pip install XulbuX
 
 ```python
 # GENERAL LIBRARY
-import XulbuX as xx
+import xulbux as xx
 # CUSTOM TYPES
-from XulbuX import rgba, hsla, hexa
+from xulbux import rgba, hsla, hexa
 ```
 The library **$\color{#8085FF}\textsf{XulbuX}$** (*below used as* `xx` *with above imported types*) contains the following modules:
 ```python
@@ -80,12 +84,12 @@ The library **$\color{#8085FF}\textsf{XulbuX}$** (*below used as* `xx` *with abo
   • FILE OPERATIONS          xx.File
   • JSON FILE OPERATIONS     xx.Json
   • SYSTEM ACTIONS           xx.System
-  • MANAGE ENVIRONMENT VARS  xx.EnvVars
-  • CMD LOG AND ACTIONS      xx.Cmd
-  • PRETTY PRINTING          xx.FormatCodes
-  • COLOR OPERATIONS         xx.Color
+  • MANAGE THE ENV PATH VAR  xx.EnvPath
+  • CONSOLE LOG AND ACTIONS  xx.Console
+  • EASY PRETTY PRINTING     xx.FormatCodes
+  • WORKING WITH COLORS      xx.Color
   • DATA OPERATIONS          xx.Data
-  • STR OPERATIONS           xx.String
+  • STRING OPERATIONS        xx.String
   • CODE STRING OPERATIONS   xx.Code
   • REGEX PATTERN TEMPLATES  xx.Regex
 ```

{xulbux-1.5.5 → xulbux-1.5.8}/README.md

@@ -2,15 +2,15 @@
 
 **$\color{#8085FF}\textsf{XulbuX}$** is a library which includes a lot of really helpful classes, types and functions.
 
-For the libraries latest changes, see the [change log](https://github.com/XulbuX-dev/Python/blob/main/Libraries/XulbuX/CHANGELOG.md).<br>
-For precise information about the library, see the library's [Wiki page](https://github.com/XulbuX-dev/Python/wiki).
+For the libraries latest changes, see the [change log](https://github.com/XulbuX-dev/PythonLibraryXulbuX/blob/main/CHANGELOG.md).<br>
+For precise information about the library, see the library's [Wiki page](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki).
 
 
 ## Installation
 
 On all operating systems, run the following command:
 ```bash
-pip install XulbuX
+pip install xulbux
 ```
 
 
@@ -18,9 +18,9 @@ pip install XulbuX
 
 ```python
 # GENERAL LIBRARY
-import XulbuX as xx
+import xulbux as xx
 # CUSTOM TYPES
-from XulbuX import rgba, hsla, hexa
+from xulbux import rgba, hsla, hexa
 ```
 The library **$\color{#8085FF}\textsf{XulbuX}$** (*below used as* `xx` *with above imported types*) contains the following modules:
 ```python
@@ -32,12 +32,12 @@ The library **$\color{#8085FF}\textsf{XulbuX}$** (*below used as* `xx` *with abo
   • FILE OPERATIONS          xx.File
   • JSON FILE OPERATIONS     xx.Json
   • SYSTEM ACTIONS           xx.System
-  • MANAGE ENVIRONMENT VARS  xx.EnvVars
-  • CMD LOG AND ACTIONS      xx.Cmd
-  • PRETTY PRINTING          xx.FormatCodes
-  • COLOR OPERATIONS         xx.Color
+  • MANAGE THE ENV PATH VAR  xx.EnvPath
+  • CONSOLE LOG AND ACTIONS  xx.Console
+  • EASY PRETTY PRINTING     xx.FormatCodes
+  • WORKING WITH COLORS      xx.Color
   • DATA OPERATIONS          xx.Data
-  • STR OPERATIONS           xx.String
+  • STRING OPERATIONS        xx.String
   • CODE STRING OPERATIONS   xx.Code
   • REGEX PATTERN TEMPLATES  xx.Regex
 ```

xulbux-1.5.8/documentation/Home.md

@@ -0,0 +1,71 @@
+<br id="top">
+
+**$\color{#8085FF}\Huge\textsf{XulbuX}$**
+
+-------------------------------------------------------------
+
+**$\color{#8085FF}\textsf{XulbuX}$** is a library which includes a lot of really helpful classes, types and functions.<br>
+For the libraries latest changes, see the [change log](https://github.com/XulbuX-dev/PythonLibraryXulbuX/blob/main/CHANGELOG.md).
+
+<br>
+
+# Installation
+
+Open a console and run the command:
+```css
+pip install xulbux
+```
+This should install the latest version of the library, along with some other required libraries.<br>
+To upgrade the library (*if there is a new release*) run the following command in your console:
+```css
+pip install --upgrade xulbux
+```
+
+<br>
+
+# Usage
+
+This imports the full library under the alias `xx`, so it's classes, types and functions are accessible with `xx.Class.method()`, `xx.type()` and `xx.function()`:
+```python
+import xulbux as xx
+```
+So you don't have to write `xx` in front of the library's types, you can import them directly:
+```python
+from xulbux import rgba, hsla, hexa
+```
+
+<br>
+
+# Modules
+
+| | |
+| :------------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------- |
+| <h3>[`xx_code`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_code)</h3>         | code-string operations (*changing the indent, finding function calls, ...*)               |
+| <h3>[`xx_color`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_color)</h3>       | everything around colors (*converting, blending, searching colors in strings, ...*)       |
+| <h3>[`xx_console`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_console)</h3>   | all sorts of actions related to the console (*pretty logging, advanced inputs, ...*)      |
+| <h3>[`xx_data`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_data)</h3>         | operations with data structures (*compare, generate path ID's, pretty print/format, ...*) |
+| <h3>[`xx_env_path`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_env_path)</h3> | getting and editing the PATH variable (*get paths, check for paths, add paths, ...*)      |
+<!--
+| <h3>[`xx_string`](https://github.com/XulbuX-dev/PythonLibraryXulbuX/wiki/xx_string)</h3>     | helpful actions when working with strings. (*normalize, escape, decompose, ...*)          |
+-->
+
+
+
+<br>
+<br>
+
+--------------------------------------------------------------
+[View this library on PyPI](https://pypi.org/project/XulbuX/)
+
+<div style="width:45px; height:45px; right:10px; position:absolute">
+  <a href="#top"><abbr title="go to top" style="text-decoration:none">
+    <div style="
+      font-size: 2em;
+      font-weight: bold;
+      background: #88889845;
+      border-radius: 0.2em;
+      text-align: center;
+      justify-content: center;
+    "><span style="display:none">go to top </span>🠩</div>
+  </abbr></a>
+</div>

xulbux-1.5.8/documentation/xx_code.md

@@ -0,0 +1,49 @@
+# `Code`
+This class includes methods, used to work with strings, which include code.
+
+<br>
+
+### `Code.add_indent()`
+
+This method will add `indent` spaces at the beginning of each line.<br>
+**Params:**
+- <code>code: *str*</code> the string to add the indent to
+- <code>indent: *int*</code> the amount of spaces to add (*default* `4`)
+
+**Returns:** the indented string
+
+<br>
+
+### `Code.get_tab_spaces()`
+
+This method will try to get the amount of spaces that are used for indentation.<br>
+**Param:** <code>code: *str*</code> the string to get the tab spaces from<br>
+**Returns:** the amount of spaces used for indentation
+
+<br>
+
+### `Code.change_tab_size()`
+
+This method will change the amount of spaces used for indentation.<br>
+**Params:**
+- <code>code: *str*</code> the string to change the tab size of
+- <code>new_tab_size: *int*</code> the amount of spaces to use for indentation
+- <code>remove_empty_lines: *bool*</code> whether to remove empty lines in the process
+
+**Returns:** the string with the new tab size (*and no empty lines if* `remove_empty_lines` *is true*)
+
+<br>
+
+### `Code.get_func_calls()`
+
+This method will try to get all the function/method calls (*JavaScript, Python, etc. style functions/methods*).<br>
+**Param:** <code>code: *str*</code> the string to get the function/method calls from<br>
+**Returns:** a list of function/method calls
+
+<br>
+
+### `Code.is_js()`
+
+This method will check if the code is likely to be JavaScript.<br>
+**Param:** <code>code: *str*</code> the string to check<br>
+**Returns:** `True` if the code is likely to be JavaScript and `False` otherwise