Merge pull request #1 from bybatkhuu/dev

Added utilities and update documentation

Author: bybatkhuu

.github/workflows/1.bump-version.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install -U pip
-          python -m pip install -r ./requirements/requirements.test.txt
+          python -m pip install .[test]
       - name: Test with pytest
         run: ./scripts/test.sh -l
 

.github/workflows/2.build-publish.yml

@@ -31,17 +31,17 @@ jobs:
           python -m pip install -U pip
           python -m pip install -r ./requirements/requirements.build.txt
       - name: Build and publish package
+        # run: |
+        #   echo -e "[testpypi]\nusername = __token__\npassword = ${{ secrets.TEST_PYPI_API_TOKEN }}" > ~/.pypirc
+        #   ./scripts/build.sh -c -u
+        #   rm -rfv ~/.pypirc
         run: |
-          echo -e "[testpypi]\nusername = __token__\npassword = ${{ secrets.TEST_PYPI_API_TOKEN }}" > ~/.pypirc
-          ./scripts/build.sh -c -u
+          echo -e "[pypi]\nusername = __token__\npassword = ${{ secrets.PYPI_API_TOKEN }}" > ~/.pypirc
+          ./scripts/build.sh -c -u -p
           rm -rfv ~/.pypirc
-      #   run: |
-      #     echo -e "[pypi]\nusername = __token__\npassword = ${{ secrets.PYPI_API_TOKEN }}" > ~/.pypirc
-      #     ./scripts/build.sh -c -u -p
-      #     rm -rfv ~/.pypirc
-      # - name: Build the package
-      #   run: |
-      #     ./scripts/build.sh -c
+      - name: Build the package
+        run: |
+          ./scripts/build.sh -c
       - name: Create release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -4,18 +4,17 @@
 [![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 useful utils package for python.
+'potato_utils' is collection of simple useful utils package for python.
 
 ## ✨ Features
 
-- Python module/package
-- Configuration
-- Test
-- Build
-- Documentation
-- Scripts
-- Examples
-- CI/CD
+- Python utilities
+- Datetime utilities
+- File I/O utilities
+- HTTP utilities
+- Security utilities
+- Sanitation utilities
+- Validation utilities
 
 ---
 
@@ -75,11 +74,7 @@ git clone git@github.com:bybatkhuu/module.python-utils.git && \
 **OPTION A.** [**RECOMMENDED**] Install from **PyPi**:
 
 ```sh
-# Install from staging TestPyPi:
-pip install -i https://test.pypi.org/simple -U potato_utils
-
-# Or install from production PyPi:
-# pip install -U potato_utils
+pip install -U potato_utils
 ```
 
 **OPTION B.** Install latest version directly from **GitHub** repository:
@@ -101,7 +96,7 @@ pip install -e .
 **OPTION D.** Install for **DEVELOPMENT** environment:
 
 ```sh
-pip install -r ./requirements/requirements.dev.txt
+pip install -e .[dev]
 ```
 
 **OPTION E.** Install from **pre-built release** files:
@@ -136,66 +131,12 @@ cp -r ./src/potato_utils /some/path/project/
 [**`examples/simple/main.py`**](./examples/simple/main.py):
 
 ```python
-# Standard libraries
-import sys
-import logging
-
-# Internal modules
-from potato_utils import MyClass
-
-
-logger = logging.getLogger(__name__)
-
-
-def main() -> None:
-    logging.basicConfig(
-        stream=sys.stdout,
-        level=logging.INFO,
-        datefmt="%Y-%m-%d %H:%M:%S %z",
-        format="[%(asctime)s | %(levelname)s | %(filename)s:%(lineno)d]: %(message)s",
-    )
-
-    # Pre-defined variables (for customizing and testing)
-    _items = [0.1, 0.2, 0.3, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0]
-    _config = {
-        "min_length": 4,
-        "max_length": 10,
-        "min_value": 0.0,
-        "max_value": 1.0,
-        "threshold": 0.7,
-    }
-
-    # Main example code
-    logger.info(f"Items before cleaning: {_items}")
-    _my_object = MyClass(items=_items, config=_config)
-    _items = _my_object()
-    logger.info(f"Items after cleaning: {_items}")
-
-    logger.info("Done!\n")
-    return
-
-
-if __name__ == "__main__":
-    main()
 ```
 
 👍
 
 ---
 
-## ⚙️ Configuration
-
-[**`templates/configs/config.yml`**](./templates/configs/config.yml):
-
-```yaml
-potato_utils:
-  min_length: 2
-  max_length: 100
-  min_value: 0.0
-  max_value: 1.0
-  threshold: 0.5
-```
-
 ### 🌎 Environment Variables
 
 [**`.env.example`**](./.env.example):
@@ -214,7 +155,7 @@ To run tests, run the following command:
 
 ```sh
 # Install python test dependencies:
-pip install -r ./requirements/requirements.test.txt
+pip install .[test]
 
 # Run tests:
 python -m pytest -sv -o log_cli=true

docs/.nav.yml

@@ -5,6 +5,5 @@ nav:
   - Development: dev/
   - Research: research/
   # - "*"
-  - Blog: blog/
   - Release Notes: release-notes.md
   - About: about/

docs/README.md

@@ -7,15 +7,14 @@ hide:
 
 # Introduction
 
-'potato_utils' is collection of useful utils package for python.
+'potato_utils' is collection of simple useful utils package for python.
 
 ## ✨ Features
 
-- Python module/package
-- Configuration
-- Test
-- Build
-- Documentation
-- Scripts
-- Examples
-- CI/CD
+- Python utilities
+- Datetime utilities
+- File I/O utilities
+- HTTP utilities
+- Security utilities
+- Sanitation utilities
+- Validation utilities

docs/api-docs/.nav.yml

@@ -1,3 +1,2 @@
 nav:
-  - MyClass: MyClass.md
-  # - "*"
+  - "*"

docs/api-docs/MyClass.md

@@ -0,0 +1,7 @@
+---
+title: Datetime Utilities
+---
+
+# Datetime Utilities
+
+::: src.potato_utils.dt

docs/api-docs/dt.md

@@ -0,0 +1,7 @@
+---
+title: HTTP Utilities
+---
+
+# HTTP Utilities
+
+::: src.potato_utils.http

docs/api-docs/http.md

@@ -0,0 +1,7 @@
+---
+title: IO Utilities
+---
+
+# IO Utilities
+
+::: src.potato_utils.io