[feat] ucuu demo v0.1.0

Author: wZuck

.github/workflows/gh-pages.yml

@@ -0,0 +1,33 @@
+name: Deploy Pages
+
+on:
+  push:
+    branches: [ "master" ]
+
+jobs:
+  deploy:
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+          
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./_site
+      
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}

.github/workflows/publish.yml

@@ -0,0 +1,51 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install requirements
+        run: |
+          if [ -f requirements.txt ]; then
+            python -m pip install --upgrade -r requirements.txt
+          fi
+          python -m pip install --upgrade toml
+
+      - name: Check version matches tag
+        id: check_version
+        run: |
+          TAG_VERSION="${GITHUB_REF##*/}"
+          FILE_VERSION=$(python3 -c "import toml; print(toml.load('pyproject.toml')['project']['version'])")
+          if [ "$TAG_VERSION" != "v$FILE_VERSION" ]; then
+            echo "Tag version ($TAG_VERSION) does not match pyproject.toml version ($FILE_VERSION)."
+            echo "should_publish=false" >> $GITHUB_OUTPUT
+          else
+            echo "should_publish=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Set up Python
+        if: steps.check_version.outputs.should_publish == 'true'
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.8'
+
+      - name: Install build dependencies
+        if: steps.check_version.outputs.should_publish == 'true'
+        run: python -m pip install --upgrade build
+
+      - name: Build package
+        if: steps.check_version.outputs.should_publish == 'true'
+        run: python -m build
+
+      - name: Publish to PyPI
+        if: steps.check_version.outputs.should_publish == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/python-app.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint with a single version of Python
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Tests
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Test with pytest
+      run: |
+        pytest

.gitignore

@@ -0,0 +1,5 @@
+.venv/
+.pytets*
+*.egg-info
+.python-version/
+.vscode/

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+      - id: black
+        language_version: python3.8

.python-version

@@ -0,0 +1 @@
+3.8

LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER 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.
+
+For more information, please refer to <https://unlicense.org>

README.md

@@ -0,0 +1,99 @@
+# You Can You Up (UCUU) 🚀
+--------
+[![Deploy GitHub Pages](https://github.com/wZuck/ucuu/actions/workflows/gh-pages.yml/badge.svg?branch=master)](https://github.com/wZuck/ucuu/actions/workflows/gh-pages.yml)
+
+
+> **⚠️ Important:**  
+> The majority of the code in this repository is generated using AI coding tools such as GitHub Copilot (GPT-4o) and TRAE (Doubao 1.5 Pro).  
+
+## 1. Brief Introduction
+
+**UCUU** is a Python utility library for function wrapping and proxying. It supports adding proxy logic to functions via decorators or patching, making it easy to extend, debug, and test.
+
+---
+
+## 2. Install and Usage ⚙️
+
+### 2.1 Installation
+
+You can install UCUU from PyPI:
+
+```bash
+pip install ucuu
+```
+
+Or, clone this repository and install locally:
+
+```bash
+git clone https://github.com/wZuck/ucuu.git
+cd ucuu
+pip install .
+```
+
+### 2.2 Usage
+
+#### 2.2.1 Decorator mode (wrap for functions)
+
+> Example: Use a decorator to add a proxy function.  
+> **Effect:** When `my_func` is called, it prints "My function logic" and then the proxy prints "Hello, hello ucuu".
+
+```python
+from ucuu.decorator import ucuu
+
+@ucuu("package_utils.print_ucuu_hello", ending_words="hello ucuu")
+def my_func():
+    print("My function logic")
+```
+
+#### 2.2.2 Patch mode (wrap for external functions)
+
+> Example: Patch an existing function with a proxy.  
+> **Effect:** When `some_func` is called, it prints "Original logic" and then the proxy prints "Hello, patch mode".
+
+```python
+from ucuu.decorator import ucuu
+
+def some_func():
+    print("Original logic")
+
+some_func = ucuu("package_utils.print_ucuu_hello", ending_words="patch mode")(some_func)
+```
+
+#### 2.2.3 Register proxy functions
+
+> Example: Implement a proxy function to be called by the decorator or patch.  
+> **Effect:** Prints different messages depending on the `ending_words` argument.
+
+```python
+# tests/package_utils/test_print.py
+def print_ucuu_hello(ending_words=None, *args, **kwargs):
+    if ending_words is None:
+        print("No Ending Words.")
+    elif ending_words == "please raise errors":
+        raise NotImplementedError('Raise Error due to requests')
+    else:
+        print(f"Hello, {ending_words}")
+```
+
+---
+
+## 3. Demos in Testcases 🧪
+
+- See the `tests/` directory for test cases covering decorator usage, patching, exception handling, argument binding, and more.
+
+
+---
+
+## 4. License 📄
+
+[MIT License](./LICENSE)
+
+---
+
+## 5. Contribute 🤝
+
+Contributions via PR or issues are welcome!  
+For suggestions or questions, please leave a message at [GitHub Issues](https://github.com/wZuck/ucuu/issues).
+
+---
+

pyproject.toml

@@ -0,0 +1,42 @@
+[project]
+name = "ucuu"
+version = "0.1.0"
+description = "A lightweight and extensible Python utility toolkit for productivity and automation."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.8"
+dependencies = [
+    "rich>=14.0.0",
+    "black>=24.0.0",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+authors = [
+    { name = "wZuck", email = "wzuck.wang@gmail.com" }
+]
+[project.urls]
+homepage = "https://wzuck.github.io/ucuu/"
+repository = "https://github.com/wZuck/ucuu"
+documentation = "https://github.com/wZuck/ucuu"
+pypi = "https://pypi.org/project/ucuu/"
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+
+[tool.pre-commit]
+
+[project.optional-dependencies]
+docs = [
+    "ghp-import>=2.1.0"
+]
+publish = [
+    "build>=1.0.0",
+    "twine>=4.0.0"
+]

requirements.txt

@@ -0,0 +1,28 @@
+# This file was autogenerated by uv via the following command:
+#    uv pip compile pyproject.toml --output-file requirements.txt
+black==24.8.0
+    # via ucuu (pyproject.toml)
+click==8.1.8
+    # via black
+markdown-it-py==3.0.0
+    # via rich
+mdurl==0.1.2
+    # via markdown-it-py
+mypy-extensions==1.1.0
+    # via black
+packaging==25.0
+    # via black
+pathspec==0.12.1
+    # via black
+platformdirs==4.3.6
+    # via black
+pygments==2.19.1
+    # via rich
+rich==14.0.0
+    # via ucuu (pyproject.toml)
+tomli==2.2.1
+    # via black
+typing-extensions==4.13.2
+    # via
+    #   black
+    #   rich