Merge pull request #2 from bybatkhuu/dev

🐛 Add utility functions for date and time handling, HTTP requests…

Author: bybatkhuu

README.md

@@ -4,7 +4,7 @@
 [![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)
 
-'potato_utils' is collection of simple useful utils package for python.
+'potato_util' is collection of simple useful utils package for python.
 
 ## ✨ Features
 
@@ -74,7 +74,7 @@ git clone git@github.com:bybatkhuu/module.python-utils.git && \
 **OPTION A.** [**RECOMMENDED**] Install from **PyPi**:
 
 ```sh
-pip install -U potato_utils
+pip install -U potato-util
 ```
 
 **OPTION B.** Install latest version directly from **GitHub** repository:
@@ -106,10 +106,10 @@ pip install -e .[dev]
 
 ```sh
 # Install from .whl file:
-pip install ./potato_utils-[VERSION]-py3-none-any.whl
+pip install ./potato_util-[VERSION]-py3-none-any.whl
 
 # Or install from .tar.gz file:
-pip install ./potato_utils-[VERSION].tar.gz
+pip install ./potato_util-[VERSION].tar.gz
 ```
 
 **OPTION F.** Copy the **module** into the project directory (for **testing**):
@@ -119,9 +119,9 @@ pip install ./potato_utils-[VERSION].tar.gz
 pip install -r ./requirements.txt
 
 # Copy the module source code into the project:
-cp -r ./src/potato_utils [PROJECT_DIR]
+cp -r ./src/potato_util [PROJECT_DIR]
 # For example:
-cp -r ./src/potato_utils /some/path/project/
+cp -r ./src/potato_util /some/path/project/
 ```
 
 ## 🚸 Usage/Examples

__init__.py

@@ -1,6 +1,6 @@
 # flake8: noqa
 
 try:
-    from .src.potato_utils import *
+    from .src.potato_util import *
 except ImportError:
-    from src.potato_utils import *
+    from src.potato_util import *

docs/README.md

@@ -7,7 +7,7 @@ hide:
 
 # Introduction
 
-'potato_utils' is collection of simple useful utils package for python.
+'potato_util' is collection of simple useful utils package for python.
 
 ## ✨ Features
 

docs/api-docs/dt.md

@@ -4,4 +4,4 @@ title: Datetime Utilities
 
 # Datetime Utilities
 
-::: src.potato_utils.dt
+::: src.potato_util.dt

docs/api-docs/http.md

@@ -4,4 +4,4 @@ title: HTTP Utilities
 
 # HTTP Utilities
 
-::: src.potato_utils.http
+::: src.potato_util.http

docs/api-docs/io.md

@@ -4,4 +4,4 @@ title: IO Utilities
 
 # IO Utilities
 
-::: src.potato_utils.io
+::: src.potato_util.io

docs/api-docs/sanitizer.md

@@ -4,4 +4,4 @@ title: Sanitizer Utilities
 
 # Sanitizer Utilities
 
-::: src.potato_utils.sanitizer
+::: src.potato_util.sanitizer

docs/api-docs/secure.md

@@ -4,4 +4,4 @@ title: Secure Utilities
 
 # Secure Utilities
 
-::: src.potato_utils.secure
+::: src.potato_util.secure

docs/api-docs/validator.md

@@ -4,4 +4,4 @@ title: Validator Utilities
 
 # Validator Utilities
 
-::: src.potato_utils.validator
+::: src.potato_util.validator

docs/dev/file-structure.md

@@ -28,7 +28,7 @@ project/
 |   |   ├── module_1/
 |   |   ├── module_2/
 |   |   └── .../
-|   └── potato_utils/            # Main CODEBASE of this project as a python module
+|   └── potato_util/            # Main CODEBASE of this project as a python module
 |       ├── __init__.py             # Initialize the module to be used as a package
 |       ├── __version__.py          # Version of the module (should be updated and used with each release)
 |       └── ...                     # Other main python files of this module