absfuyu 4.2.0__tar.gz → 5.0.0__tar.gz

{absfuyu-4.2.0 → absfuyu-5.0.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: absfuyu
-Version: 4.2.0
+Version: 5.0.0
 Summary: A small collection of code
 Project-URL: Homepage, https://github.com/AbsoluteWinter/absfuyu-public
 Project-URL: Documentation, https://absolutewinter.github.io/absfuyu-docs/
 Project-URL: Repository, https://github.com/AbsoluteWinter/absfuyu-public
 Project-URL: Issues, https://github.com/AbsoluteWinter/absfuyu-public/issues
 Author: somewhatcold (AbsoluteWinter)
-License: MIT License
+License-Expression: MIT
 License-File: LICENSE
 Keywords: utilities
 Classifier: Development Status :: 5 - Production/Stable
@@ -28,16 +28,16 @@ Requires-Python: <4,>=3.11
 Requires-Dist: bs4
 Requires-Dist: click>=8.0.0
 Requires-Dist: colorama
-Requires-Dist: deprecated
-Requires-Dist: python-dateutil
 Requires-Dist: requests
-Requires-Dist: typing-extensions>=4.5.0; python_version < '3.12'
-Requires-Dist: unidecode
 Provides-Extra: beautiful
 Requires-Dist: rich; extra == 'beautiful'
 Provides-Extra: dev
 Requires-Dist: hatch; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: numpy; extra == 'docs'
+Requires-Dist: pandas; extra == 'docs'
+Requires-Dist: rich; extra == 'docs'
 Provides-Extra: extra
 Requires-Dist: numpy; extra == 'extra'
 Requires-Dist: pandas; extra == 'extra'
@@ -46,6 +46,7 @@ Requires-Dist: numpy; extra == 'full'
 Requires-Dist: pandas; extra == 'full'
 Requires-Dist: rich; extra == 'full'
 Requires-Dist: tqdm; extra == 'full'
+Requires-Dist: unidecode; extra == 'full'
 Description-Content-Type: text/markdown
 
 <div align="center">
@@ -66,10 +67,12 @@ Description-Content-Type: text/markdown
 
 ## **SUMMARY:**
 
-*TL;DR: A collection of code*
+This project is a collection of code primarily developed as a personal hobby. It aims to provide practical experience and enhance my coding skills while exploring potential future applications.
 
 ## **INSTALLATION:**
 
+To install the package, run the following command:
+
 ```bash
 pip install -U absfuyu
 ```
@@ -81,31 +84,55 @@ import absfuyu
 help(absfuyu)
 ```
 
+### Notable features
+
+**absfuyu.core**: Provides foundational components for additional functionalities.
+
+```python
+# Decorators that adds info to __doc__
+from absfuyu.core.docstring import versionadded, versionchanged, deprecated
+
+# Class mixins for enhanced functionality
+from absfuyu.core.baseclass import AutoREPRMixin, ShowAllMethodsMixin
+```
+
+**absfuyu.dxt**: Extension for `list`, `str`, `dict`, `int`.
+
+```python
+from absfuyu.dxt import DictExt, IntExt, ListExt, Text
+for x in [DictExt, IntExt, ListExt, Text]:
+    x.show_all_methods(print_result=1)
+```
+
+There are many additional features available to explore.
+
 ## **DOCUMENTATION:**
 
-> [here](https://absolutewinter.github.io/absfuyu/)
+For more detailed information about the project, please refer to the documentation available at the following link:
+
+> [Project Documentation](https://absolutewinter.github.io/absfuyu/)
 
-## **DEV SETUP**
+## **DEVELOPMENT SETUP**
 
-1. Create virtual environment
+1. Create a Virtual Environment
 
 ```bash
 python -m venv env
 ```
 
-Note: Might need to run this in powershell (windows)
+Note: You may need to execute this command in PowerShell on Windows:
 
 ```powershell
 Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser
 ```
 
-2. Install required packages
+2. Install Required Packages
 
 ```bash
 python -m pip install -e .[full,dev]
 ```
 
-3. Getting info of dev environment
+3. Acquire Information About the Development Environment Configuration
 
 ```bash
 hatch env show
@@ -113,4 +140,4 @@ hatch env show
 
 ## **LICENSE:**
 
-MIT License
+This project is licensed under the MIT License.

absfuyu-5.0.0/README.md

@@ -0,0 +1,92 @@
+<div align="center">
+    <h1 align="center">
+        <img src="https://github.com/AbsoluteWinter/AbsoluteWinter.github.io/blob/main/absfuyu/images/repository-image-crop.png?raw=true" alt="absfuyu"/>
+    </h1>
+    <p align="center">
+        <a href="https://pypi.org/project/absfuyu/"><img src="https://img.shields.io/pypi/pyversions/absfuyu?style=flat-square&logo=python" alt="PyPI Supported Versions"/></a>
+        <a href="https://pypi.org/project/absfuyu/"><img src="https://img.shields.io/pypi/dm/absfuyu?style=flat-square&color=blue" alt="PyPI Downloads"/></a>
+        <a href="https://pypi.org/project/absfuyu/"><img src="https://img.shields.io/pypi/v/absfuyu?style=flat-square&logo=pypi" /></a>
+        <a><img src="https://img.shields.io/pypi/l/absfuyu?style=flat-square&logo=github&color=blue"/></a>
+        <a><img src="https://img.shields.io/badge/code%20style-black-black?style=flat-square"/></a>
+        <a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=flat-square" alt="Ruff" style="max-width:100%;"></a>
+    </p>
+</div>
+
+---
+
+## **SUMMARY:**
+
+This project is a collection of code primarily developed as a personal hobby. It aims to provide practical experience and enhance my coding skills while exploring potential future applications.
+
+## **INSTALLATION:**
+
+To install the package, run the following command:
+
+```bash
+pip install -U absfuyu
+```
+
+## **USAGE:**
+
+```python
+import absfuyu
+help(absfuyu)
+```
+
+### Notable features
+
+**absfuyu.core**: Provides foundational components for additional functionalities.
+
+```python
+# Decorators that adds info to __doc__
+from absfuyu.core.docstring import versionadded, versionchanged, deprecated
+
+# Class mixins for enhanced functionality
+from absfuyu.core.baseclass import AutoREPRMixin, ShowAllMethodsMixin
+```
+
+**absfuyu.dxt**: Extension for `list`, `str`, `dict`, `int`.
+
+```python
+from absfuyu.dxt import DictExt, IntExt, ListExt, Text
+for x in [DictExt, IntExt, ListExt, Text]:
+    x.show_all_methods(print_result=1)
+```
+
+There are many additional features available to explore.
+
+## **DOCUMENTATION:**
+
+For more detailed information about the project, please refer to the documentation available at the following link:
+
+> [Project Documentation](https://absolutewinter.github.io/absfuyu/)
+
+## **DEVELOPMENT SETUP**
+
+1. Create a Virtual Environment
+
+```bash
+python -m venv env
+```
+
+Note: You may need to execute this command in PowerShell on Windows:
+
+```powershell
+Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser
+```
+
+2. Install Required Packages
+
+```bash
+python -m pip install -e .[full,dev]
+```
+
+3. Acquire Information About the Development Environment Configuration
+
+```bash
+hatch env show
+```
+
+## **LICENSE:**
+
+This project is licensed under the MIT License.

absfuyu-5.0.0/docs/_template/versioning.html

@@ -0,0 +1,27 @@
+{%- if current_version %}
+<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
+    <span class="rst-current-version" data-toggle="rst-current-version">
+        <span class="fa fa-book"> Other Versions</span>
+        v: {{ current_version.name }}
+        <span class="fa fa-caret-down"></span>
+    </span>
+    <div class="rst-other-versions">
+        {%- if versions.tags %}
+        <dl>
+            <dt>Tags</dt>
+            {%- for item in versions.tags %}
+            <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
+            {%- endfor %}
+        </dl>
+        {%- endif %}
+        {%- if versions.branches %}
+        <dl>
+            <dt>Branches</dt>
+            {%- for item in versions.branches %}
+            <dd><a href="{{ item.url }}">{{ item.name }}</a></dd>
+            {%- endfor %}
+        </dl>
+        {%- endif %}
+    </div>
+</div>
+{%- endif %}

{absfuyu-4.2.0 → absfuyu-5.0.0}/docs/conf.py

@@ -5,7 +5,6 @@
 
 import os
 import sys
-from datetime import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -14,8 +13,8 @@ from absfuyu import __author__, __title__, __version__
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = __title__
-copyright = f"2022-{datetime.now().year}, {__author__}"
+project = f"{__title__}"
+copyright = f"2022-%Y, {__author__}"
 author = __author__
 version = __version__
 release = version
@@ -23,6 +22,8 @@ release = version
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
+needs_sphinx = "8.1"
+
 extensions = [
     "sphinx.ext.autodoc",  # include documentation
     "sphinx.ext.autosummary",
@@ -58,7 +59,9 @@ source_suffix = {
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 
-# html_title = f"ABSFUYU'S DOCUMENTATION v{__version__}"
+html_title = f"{__title__.upper()}'S DOCUMENTATION v{__version__}"
+html_short_title = f"{__title__} v{__version__}"
+# html_logo = "https://github.com/AbsoluteWinter/AbsoluteWinter.github.io/blob/75568549d30f447a66baac8ecc3b5e6b49a67d18/absfuyu/images/LOGO.png?raw=true"
 
 html_theme = "sphinx_rtd_theme"
 html_static_path = ["_static"]
@@ -69,6 +72,11 @@ html_show_sourcelink = False
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 html_show_sphinx = False
 
+html_sidebars = {
+    "**": [
+        "versioning.html",
+    ],
+}
 
 # -- Extension configuration -------------------------------------------------
 

absfuyu-4.2.0/README.md → absfuyu-5.0.0/docs/info.md

@@ -14,53 +14,73 @@
 
 ---
 
-## **SUMMARY:**
+# SUMMARY
 
-*TL;DR: A collection of code*
+This project is a collection of code primarily developed as a personal hobby. It aims to provide practical experience and enhance my coding skills while exploring potential future applications.
 
-## **INSTALLATION:**
+# INSTALLATION
+
+To install the package, run the following command:
 
 ```bash
 pip install -U absfuyu
 ```
 
-## **USAGE:**
+# USAGE
 
 ```python
 import absfuyu
 help(absfuyu)
 ```
 
-## **DOCUMENTATION:**
+## Notable features
+
+**absfuyu.core**: Provides foundational components for additional functionalities.
+
+```python
+# Decorators that adds info to __doc__
+from absfuyu.core.docstring import versionadded, versionchanged, deprecated
+
+# Class mixins for enhanced functionality
+from absfuyu.core.baseclass import AutoREPRMixin, ShowAllMethodsMixin
+```
+
+**absfuyu.dxt**: Extension for `list`, `str`, `dict`, `int`.
+
+```python
+from absfuyu.dxt import DictExt, IntExt, ListExt, Text
+for x in [DictExt, IntExt, ListExt, Text]:
+    x.show_all_methods(print_result=1)
+```
 
-> [here](https://absolutewinter.github.io/absfuyu/)
+There are many additional features available to explore.
 
-## **DEV SETUP**
+# DEVELOPMENT SETUP
 
-1. Create virtual environment
+1. Create a Virtual Environment
 
 ```bash
 python -m venv env
 ```
 
-Note: Might need to run this in powershell (windows)
+Note: You may need to execute this command in PowerShell on Windows:
 
 ```powershell
 Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser
 ```
 
-2. Install required packages
+2. Install Required Packages
 
 ```bash
 python -m pip install -e .[full,dev]
 ```
 
-3. Getting info of dev environment
+3. Acquire Information About the Development Environment Configuration
 
 ```bash
 hatch env show
 ```
 
-## **LICENSE:**
+# LICENSE
 
-MIT License
+This project is licensed under the MIT License.

{absfuyu-4.2.0 → absfuyu-5.0.0}/pyproject.toml

@@ -10,7 +10,7 @@
 
 # MARK: BUILD ====================
 [build-system]
-requires = ["hatchling>=1.22.2", "hatch-vcs>=0.3.0"]
+requires = ["hatchling>=1.27.0", "hatch-vcs>=0.3.0"]
 build-backend = "hatchling.build"
 
 # MARK: PROJECT ====================
@@ -19,7 +19,8 @@ name = "absfuyu"
 description = "A small collection of code"
 readme = { "file" = "README.md", "content-type" = "text/markdown" }
 requires-python = ">=3.11, <4"
-license = { text = "MIT License" }
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
 keywords = ["utilities"]
 authors = [{ name = "somewhatcold (AbsoluteWinter)" }]
 classifiers = [
@@ -43,11 +44,8 @@ dependencies = [
     "bs4",
     "click>=8.0.0",
     "colorama",
-    "Deprecated",
-    "python-dateutil",
     "requests",
-    "typing_extensions>=4.5.0; python_version < '3.12'",
-    "unidecode",
+    # "typing_extensions>=4.5.0; python_version < '3.12'",
 ]
 
 dynamic = ["version"]
@@ -59,7 +57,8 @@ Repository = "https://github.com/AbsoluteWinter/absfuyu-public"
 Issues = "https://github.com/AbsoluteWinter/absfuyu-public/issues"
 
 [project.optional-dependencies]
-full = ["numpy", "pandas", "rich", "tqdm"]
+full = ["numpy", "pandas", "rich", "tqdm", "unidecode"]
+docs = ["numpy", "pandas", "rich"]
 beautiful = ["rich"]
 extra = ["numpy", "pandas"]
 dev = ["hatch", "pytest"]
@@ -78,7 +77,7 @@ only-include = ["src", "tests", "docs", "images", "dev_requirements.txt"]
 
 # Set up virtual env: use hatch env show
 [tool.hatch.envs.default]
-dependencies = ["coverage[toml]", "pytest-cov", "pytest"]
+dependencies = ["coverage[toml]", "pytest", "pytest-cov"]
 description = """
 Default environment
 
@@ -96,6 +95,7 @@ cov = ["test-cov", "cov-report"]                                    # use this
 cov2 = "pytest --cov-report=term-missing --cov=absfuyu --cov=tests" # use this
 
 [tool.hatch.envs.all]
+dependencies = ["coverage[toml]", "pytest", "pytest-cov", "pytest-xdist"]
 features = ["full"]
 description = """
 All python version to test:
@@ -106,6 +106,7 @@ Use `hatch run all:install` when occur "no module named" error
 
 [tool.hatch.envs.all.scripts]
 install = "pip install -e .[full]" # This command fix "no module named"
+test2 = "pytest -n auto"           # parallel test
 
 [[tool.hatch.envs.all.matrix]] # hatch env run -e all test
 python = ["3.11", "3.12", "3.13"]
@@ -120,9 +121,9 @@ check = "mypy --install-types --non-interactive {args:src/absfuyu}"
 # check = "mypy --install-types --non-interactive {args:src/absfuyu tests}"
 
 [tool.hatch.envs.docs]
-features = ["full"]
+features = ["docs"]
 dependencies = [
-    "sphinx>=7.0.0",
+    "sphinx>=8.1.0",
     "sphinx_rtd_theme",
     "sphinx_copybutton",
     "myst-parser",       # Markdown parser
@@ -138,13 +139,36 @@ Main cmd:
 """
 
 [tool.hatch.envs.docs.scripts]
+clean = [
+    """
+    python -c "print('Cleaning up...')"
+    """,
+    """
+    python -c "import shutil;from pathlib import Path;shutil.rmtree(Path.cwd().joinpath('docs', 'build'))"
+    """, # Delete docs/build/ folder
+    """
+    python -c "from pathlib import Path;[x.unlink() for x in Path.cwd().joinpath('docs').glob('absfuyu*.rst')]"
+    """, # Clean .rst files in docs/ folder
+    """
+    python -c "print('Cleaning up...DONE')"
+    """,
+]
+build_private = [
+    # -f --force
+    # -e --separate
+    # -M --module-first
+    # -P --private
+    "sphinx-apidoc -o docs/ src/absfuyu -feMP",
+    "sphinx-build docs docs/build",
+]
 build = [
-    "sphinx-apidoc -o docs/ src/absfuyu", # Generate
-    "sphinx-build docs docs/build",       # Build
+    "clean",
+    "sphinx-apidoc -o docs/ src/absfuyu -eM", # Generate
+    "sphinx-build docs docs/build",           # Build
 ]
 live = [
-    "sphinx-apidoc -o docs/ src/absfuyu", # Generate
-    "sphinx-autobuild docs docs/build",   # Live preview
+    "sphinx-apidoc -o docs/ src/absfuyu -feM", # Generate
+    "sphinx-autobuild docs docs/build",        # Live preview
 ]
 
 [tool.hatch.envs.style]
@@ -179,9 +203,12 @@ Options:
 """
 
 [tool.hatch.envs.workflow.scripts]
-test = [
+qa = [
     "hatch run style:fmt",   # Code quality check
     "hatch run types:check", # type-hint check
+]
+test = [
+    "qa",
     "hatch run all:test",    # Test
 ]
 build = [
@@ -243,7 +270,10 @@ addopts = [
 ]
 markers = [ # pytest -m <marker> -v
     "test_this: Select desire tests to test",
-    "data_extension: Test all data extension classes",
+    "abs_core: Test in absfuyu.core",
+    "abs_dxt: Test in absfuyu.dxt",
+    "abs_fun: Test in absfuyu.fun",
+    "abs_shape: Test in absfuyu.general.shape",
     "abs_tools: Test in absfuyu.tools",
     "abs_util: Test in absfuyu.util",
 ]

{absfuyu-4.2.0 → absfuyu-5.0.0}/src/absfuyu/__init__.py

@@ -15,19 +15,19 @@ Normal import:
 >>> import absfuyu
 >>> help(absfuyu)
 
-Using in cmd (`absfuyu[cli]` required):
+Using in cmd:
 ``$ fuyu --help``
 """
 
 __title__ = "absfuyu"
 __author__ = "AbsoluteWinter"
 __license__ = "MIT License"
-__version__ = "4.2.0"
+__version__ = "5.0.0"
 __all__ = [
     "core",
     "config",
-    "everything",
-    "extensions",
+    "dxt",
+    "extra",
     "logger",
     "fun",
     "game",

absfuyu-5.0.0/src/absfuyu/__main__.py

@@ -0,0 +1,27 @@
+"""
+ABSFUYU
+-------
+COMMAND LINE INTERFACE
+
+Version: 5.0.0
+Date updated: 18/02/2025 (dd/mm/yyyy)
+"""
+
+# Library
+# ---------------------------------------------------------------------------
+try:
+    from absfuyu.cli import cli
+except ModuleNotFoundError:  # Check for `click`, `colorama`
+    from absfuyu.core.dummy_cli import cli
+
+
+# Function
+# ---------------------------------------------------------------------------
+def main() -> None:
+    cli()
+
+
+# Run
+# ---------------------------------------------------------------------------
+if __name__ == "__main__":
+    main()

{absfuyu-4.2.0 → absfuyu-5.0.0}/src/absfuyu/cli/color.py

@@ -7,10 +7,17 @@ Version: 1.0.0
 Date updated: 14/04/2024 (dd/mm/yyyy)
 """
 
+# Module Package
+# ---------------------------------------------------------------------------
 __all__ = ["COLOR"]
 
+
+# Library
+# ---------------------------------------------------------------------------
 import colorama
 
+# Color
+# ---------------------------------------------------------------------------
 COLOR = {
     "green": colorama.Fore.LIGHTGREEN_EX,
     "GREEN": colorama.Fore.GREEN,

{absfuyu-4.2.0 → absfuyu-5.0.0}/src/absfuyu/cli/do_group.py

@@ -16,7 +16,6 @@ import click
 from absfuyu import __title__
 from absfuyu.cli.color import COLOR
 from absfuyu.core import __package_feature__
-from absfuyu.general.human import Human2
 from absfuyu.tools.shutdownizer import ShutDownizer
 from absfuyu.util.zipped import Zipper
 from absfuyu.version import PkgVersion
@@ -60,37 +59,6 @@ def install(pkg: str) -> None:
         click.echo(f"{COLOR['green']}absfuyu[{pkg}] installed")
 
 
-@click.command()
-def advice() -> None:
-    """Give some recommendation when bored"""
-    from absfuyu.fun import im_bored
-
-    click.echo(f"{COLOR['green']}{im_bored()}")
-
-
-@click.command(name="fs")
-@click.argument("date", type=str)
-@click.argument("number_string", type=str)
-def fs(date: str, number_string: str) -> None:
-    """Feng-shui W.I.P"""
-
-    instance = Human2(date)
-    print(instance.fs(number_string))
-
-
-@click.command(name="info")
-@click.argument("date", type=str)
-def info(date: str) -> None:
-    """
-    Day info, format: yyyymmdd
-
-    Remake this
-    """
-
-    instance = Human2(date)
-    print(instance.info())
-
-
 @click.command(name="unzip")
 @click.argument("dir", type=str)
 def unzip_files_in_dir(dir: str) -> None:
@@ -116,8 +84,5 @@ def do_group() -> None:
 
 do_group.add_command(update)
 do_group.add_command(install)
-do_group.add_command(advice)
-do_group.add_command(fs)
-do_group.add_command(info)
 do_group.add_command(unzip_files_in_dir)
 do_group.add_command(os_shutdown)

{absfuyu-4.2.0 → absfuyu-5.0.0}/src/absfuyu/cli/tool_group.py

@@ -59,19 +59,19 @@ from absfuyu.tools.converter import Base64EncodeDecode, Text2Chemistry
 )
 def file_checksum(
     file_path: str,
-    hash_mode: str | Literal["md5", "sha1", "sha256", "sha512"],
+    hash_mode: Literal["md5", "sha1", "sha256", "sha512"],
     save_result: bool,
     recursive_mode: bool,
-    hash_to_compare: str,
+    hash_to_compare: str | None,
 ) -> None:
     """Checksum for file/directory"""
     # print(hash_mode, save_result, recursive_mode)
     instance = Checksum(file_path, hash_mode=hash_mode, save_result_to_file=save_result)
     res = instance.checksum(recursive=recursive_mode)
-    if hash_to_compare:
-        print(res == hash_to_compare)
-    else:
+    if hash_to_compare is None:
         print(res)
+    else:
+        print(res == hash_to_compare)
 
 
 @click.command(name="t2c")