potato-util 0.0.3__tar.gz → 0.0.5__tar.gz

{potato_util-0.0.3/src/potato_util.egg-info → potato_util-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: potato_util
-Version: 0.0.3
+Version: 0.0.5
 Summary: 'potato_util' is collection of simple useful utils package for python.
 Author-email: Batkhuu Byambajav <batkhuu10@gmail.com>
 Project-URL: Homepage, https://github.com/bybatkhuu/module-python-utils
@@ -77,11 +77,13 @@ Requires-Dist: pyright<2.0.0,>=1.1.392; extra == "dev"
 Requires-Dist: pre-commit<5.0.0,>=4.0.1; extra == "dev"
 Dynamic: license-file
 
-# Potato Util (Python Utils)
+# Python Utils (potato-util)
 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit)
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bybatkhuu/module-python-utils/2.build-publish.yml?logo=GitHub)](https://github.com/bybatkhuu/module-python-utils/actions/workflows/2.build-publish.yml)
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/bybatkhuu/module-python-utils?logo=GitHub&color=blue)](https://github.com/bybatkhuu/module-python-utils/releases)
+[![PyPI](https://img.shields.io/pypi/v/potato-util?logo=PyPi)](https://pypi.org/project/potato-util)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/potato-util?logo=Python)](https://docs.conda.io/en/latest/miniconda.html)
 
 'potato_util' is collection of simple useful utils package for python.
 
@@ -111,7 +113,7 @@ Dynamic: license-file
 [OPTIONAL] For **DEVELOPMENT** environment:
 
 - Install [**git**](https://git-scm.com/downloads)
-- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) ([video tutorial](https://www.youtube.com/watch?v=snCP3c7wXw0))
+- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)
 
 ### 2. 📥 Download or clone the repository
 
@@ -178,6 +180,9 @@ pip install -e .
 
 ```sh
 pip install -e .[dev]
+
+# Install pre-commit hooks:
+pre-commit install
 ```
 
 **OPTION E.** Install from **pre-built release** files:

{potato_util-0.0.3 → potato_util-0.0.5}/README.md

@@ -1,8 +1,10 @@
-# Potato Util (Python Utils)
+# Python Utils (potato-util)
 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit)
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bybatkhuu/module-python-utils/2.build-publish.yml?logo=GitHub)](https://github.com/bybatkhuu/module-python-utils/actions/workflows/2.build-publish.yml)
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/bybatkhuu/module-python-utils?logo=GitHub&color=blue)](https://github.com/bybatkhuu/module-python-utils/releases)
+[![PyPI](https://img.shields.io/pypi/v/potato-util?logo=PyPi)](https://pypi.org/project/potato-util)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/potato-util?logo=Python)](https://docs.conda.io/en/latest/miniconda.html)
 
 'potato_util' is collection of simple useful utils package for python.
 
@@ -32,7 +34,7 @@
 [OPTIONAL] For **DEVELOPMENT** environment:
 
 - Install [**git**](https://git-scm.com/downloads)
-- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) ([video tutorial](https://www.youtube.com/watch?v=snCP3c7wXw0))
+- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)
 
 ### 2. 📥 Download or clone the repository
 
@@ -99,6 +101,9 @@ pip install -e .
 
 ```sh
 pip install -e .[dev]
+
+# Install pre-commit hooks:
+pre-commit install
 ```
 
 **OPTION E.** Install from **pre-built release** files:

{potato_util-0.0.3 → potato_util-0.0.5}/pyproject.toml

@@ -39,6 +39,8 @@ all = { file = [
 	"./requirements/requirements.async.txt",
 	"./requirements/requirements.fastapi.txt",
 ] }
+
+# Optional dependencies for DEVELOPMENT
 test = { file = [
 	"./requirements/requirements.async.txt",
 	"./requirements/requirements.fastapi.txt",

potato_util-0.0.5/src/potato_util/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.0.5"

{potato_util-0.0.3 → potato_util-0.0.5}/src/potato_util/_base.py

@@ -1,3 +1,5 @@
+import os
+import sys
 import re
 import copy
 import logging
@@ -51,7 +53,33 @@ def camel_to_snake(val: str) -> str:
     return val
 
 
+@validate_call
+def get_slug_name(file_path: str | None = None) -> str:
+    """Slugify the file name from the given file path or the current script's file path.
+
+    Args:
+        file_path (str | None, optional): The file path to slugify. If None, uses the current script's file path.
+                                            Defaults to None.
+
+    Returns:
+        str: The slugified file name.
+    """
+
+    if not file_path:
+        file_path = sys.argv[0]
+
+    _slug_name = (
+        os.path.splitext(os.path.basename(file_path))[0]
+        .strip()
+        .replace(" ", "-")
+        .replace("_", "-")
+        .lower()
+    )
+    return _slug_name
+
+
 __all__ = [
     "deep_merge",
     "camel_to_snake",
+    "get_slug_name",
 ]

{potato_util-0.0.3 → potato_util-0.0.5/src/potato_util.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: potato_util
-Version: 0.0.3
+Version: 0.0.5
 Summary: 'potato_util' is collection of simple useful utils package for python.
 Author-email: Batkhuu Byambajav <batkhuu10@gmail.com>
 Project-URL: Homepage, https://github.com/bybatkhuu/module-python-utils
@@ -77,11 +77,13 @@ Requires-Dist: pyright<2.0.0,>=1.1.392; extra == "dev"
 Requires-Dist: pre-commit<5.0.0,>=4.0.1; extra == "dev"
 Dynamic: license-file
 
-# Potato Util (Python Utils)
+# Python Utils (potato-util)
 
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit)
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/bybatkhuu/module-python-utils/2.build-publish.yml?logo=GitHub)](https://github.com/bybatkhuu/module-python-utils/actions/workflows/2.build-publish.yml)
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/bybatkhuu/module-python-utils?logo=GitHub&color=blue)](https://github.com/bybatkhuu/module-python-utils/releases)
+[![PyPI](https://img.shields.io/pypi/v/potato-util?logo=PyPi)](https://pypi.org/project/potato-util)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/potato-util?logo=Python)](https://docs.conda.io/en/latest/miniconda.html)
 
 'potato_util' is collection of simple useful utils package for python.
 
@@ -111,7 +113,7 @@ Dynamic: license-file
 [OPTIONAL] For **DEVELOPMENT** environment:
 
 - Install [**git**](https://git-scm.com/downloads)
-- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh) ([video tutorial](https://www.youtube.com/watch?v=snCP3c7wXw0))
+- Setup an [**SSH key**](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh)
 
 ### 2. 📥 Download or clone the repository
 
@@ -178,6 +180,9 @@ pip install -e .
 
 ```sh
 pip install -e .[dev]
+
+# Install pre-commit hooks:
+pre-commit install
 ```
 
 **OPTION E.** Install from **pre-built release** files:

potato_util-0.0.3/src/potato_util/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.0.3"