winipedia-utils 0.1.0__py3-none-any.whl

winipedia_utils-0.1.0.dist-info/METADATA

@@ -0,0 +1,350 @@
+Metadata-Version: 2.3
+Name: winipedia-utils
+Version: 0.1.0
+Summary: A package with many utility functions
+License: MIT
+Author: Winipedia
+Requires-Python: >=3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: defusedxml (>=0.7.1,<0.8.0)
+Requires-Dist: django (>=5.2.1,<6.0.0)
+Requires-Dist: pathspec (>=0.12.1,<0.13.0)
+Requires-Dist: setuptools (>=80.3.1,<81.0.0)
+Requires-Dist: tomlkit (>=0.13.2,<0.14.0)
+Requires-Dist: tqdm (>=4.67.1,<5.0.0)
+Description-Content-Type: text/markdown
+
+# Winipedia Utils
+
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![Poetry](https://img.shields.io/badge/dependency%20management-poetry-blue.svg)](https://python-poetry.org/)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Type checked: mypy](https://img.shields.io/badge/type%20checked-mypy-blue.svg)](https://mypy-lang.org/)
+[![Security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://bandit.readthedocs.io/)
+
+A comprehensive Python utility ecosystem designed to scale into an all-in-one toolkit for Python development. Winipedia Utils provides battle-tested utilities for Django, dataframes, strings, concurrent processing, iterating, and any other tools needed for full Python projects, while enforcing clean code practices through automated tooling.
+
+## 🎯 Core Purpose
+
+Winipedia Utils serves as the **foundation for reducing repeated code** across Python projects while **enforcing clean code practices** through automated tooling. The project setup script automatically configures your development environment with industry best practices, ensuring consistent code quality across all your projects.
+
+### Key Benefits
+
+- **🚀 Zero-configuration setup** - Complete development environment in one command
+- **🧪 Automated test generation** - 100% test coverage scaffolding for your entire codebase
+- **🔍 Quality assurance** - Automated linting, type checking, and security scanning
+- **📦 Comprehensive utilities** - Growing collection of production-ready utility functions
+- **🔄 Consistent standards** - Enforced code style and testing patterns across projects
+
+## 🏗️ Some Implementation
+
+### Project Setup & Automation
+- **Automated dependency installation** (ruff, mypy, pytest, bandit, pre-commit)
+- **Pre-commit hook configuration** for code quality enforcement
+- **pyproject.toml configuration** with optimal tool settings
+- **Complete development environment setup** in a single command
+
+### Core Utility Modules
+
+#### 🧪 Testing Infrastructure (`testing/`)
+- **Automated test file generation** for entire codebases
+- **Test stub creation** for every function, class, and method
+- **Mirror test structure** maintaining 1:1 correspondence with source code
+- **Testing convention enforcement** with pytest integration
+
+#### 🔍 Module Introspection (`modules/`)
+- **Package discovery and manipulation** utilities
+- **Dynamic module creation and import** capabilities
+- **Code analysis and extraction** tools
+- **Python object introspection** and manipulation
+
+#### ⚡ Concurrent Processing (`concurrent/`)
+- **Multiprocessing utilities** with automatic worker optimization
+- **Multithreading support** for I/O-bound tasks
+- **Timeout handling** and process management
+- **Progress tracking** with tqdm integration
+
+#### 🌐 Django Utilities (`django/`)
+- **Bulk operations** with multithreaded processing for create, update, delete
+- **Advanced BaseCommand** with logging, validation, and common arguments
+- **Database utilities** including model hashing and topological sorting
+- **Model introspection** and dependency analysis tools
+
+#### 📊 Data Processing (`data/`)
+- **DataFrame utilities** for data manipulation and analysis
+- **Data cleaning and transformation** operations
+- **Aggregation and preprocessing** tools
+
+#### 🔄 Iterating Utilities (`iterating/`)
+- **Iterable manipulation** with safe length operations
+- **Generator utilities** and iteration helpers
+- **Collection processing** tools
+
+#### 📝 Text Processing (`text/`)
+- **String manipulation** utilities
+- **XML parsing** with security features
+- **Input handling** with timeout support
+- **Hash generation** and text truncation
+
+#### 🔧 Development Tools
+- **Git integration** (`git/`) - gitignore handling, pre-commit management
+- **Logging configuration** (`logging/`) - standardized logging setup
+- **OS utilities** (`os/`) - command finding, subprocess management
+- **OOP enhancements** (`oop/mixins/`) - advanced metaclasses and mixins
+- **Project configuration** (`projects/poetry/`) - Poetry integration and management
+
+## 🚀 Installation & Quick Start
+
+### Prerequisites
+- Python 3.12+
+- Poetry (for dependency management)
+
+### Installation
+
+```bash
+# Add to your project
+poetry add winipedia-utils
+
+# Run the setup script
+poetry run python -m winipedia_utils.setup
+```
+
+### What Happens During Setup
+
+The setup script automatically:
+
+1. **Installs development dependencies**: ruff, mypy, pytest, bandit, pre-commit, and type stubs
+2. **Configures pre-commit hooks**: Automated code quality checks on every commit
+3. **Sets up pyproject.toml**: Optimal configurations for all development tools
+4. **Generates comprehensive tests**: Creates test files for your entire codebase
+5. **Runs initial quality checks**: Ensures everything is properly configured
+
+```python
+# winipedia_utils/setup.py
+def _setup() -> None:
+    """Set up the project."""
+    _install_dev_dependencies()           # Install quality tools
+    _add_package_hook_to_pre_commit_config()  # Configure pre-commit
+    _add_tool_configurations_to_pyproject_toml()  # Setup tool configs
+    _run_all_hooks()                      # Generate tests & run checks
+    logger.info("Setup complete!")
+```
+
+## 💡 Usage Examples
+
+### Automated Test Generation
+
+```python
+from winipedia_utils.testing.create_tests import create_tests
+
+# Automatically generate test files for your entire project
+create_tests()
+# Creates comprehensive test structure with stubs for every function/class
+```
+
+### Module Introspection
+
+```python
+from winipedia_utils.modules.package import get_scr_package, walk_package
+from winipedia_utils.modules.function import get_all_functions_from_module
+
+# Discover your main source package
+src_package = get_scr_package()
+
+# Walk through all modules in a package
+for package, modules in walk_package(src_package):
+    for module in modules:
+        functions = get_all_functions_from_module(module)
+        print(f"Found {len(functions)} functions in {module.__name__}")
+```
+
+### Concurrent Processing
+
+```python
+from winipedia_utils.concurrent.multiprocessing import multiprocess_loop
+from winipedia_utils.concurrent.multithreading import multithread_loop
+
+# CPU-bound tasks with multiprocessing
+def cpu_intensive_task(data):
+    return complex_calculation(data)
+
+results = multiprocess_loop(
+    process_function=cpu_intensive_task,
+    process_args=[[item] for item in large_dataset]
+)
+
+# I/O-bound tasks with multithreading
+def io_task(url):
+    return fetch_data(url)
+
+results = multithread_loop(
+    process_function=io_task,
+    process_args=[[url] for url in urls]
+)
+```
+
+### Django Bulk Operations
+
+```python
+from winipedia_utils.django.bulk import (
+    bulk_create_in_steps,
+    bulk_update_in_steps,
+    bulk_delete_in_steps
+)
+
+# Efficient bulk creation with multithreading
+created_objects = bulk_create_in_steps(
+    model=MyModel,
+    bulk=[MyModel(name=f"item_{i}") for i in range(10000)],
+    step=1000
+)
+
+# Bulk update with field specification
+updated_count = bulk_update_in_steps(
+    model=MyModel,
+    bulk=objects_to_update,
+    update_fields=['name', 'status'],
+    step=1000
+)
+
+# Safe bulk deletion with cascade handling
+deleted_count, deletion_summary = bulk_delete_in_steps(
+    model=MyModel,
+    bulk=objects_to_delete,
+    step=1000
+)
+```
+
+### Django Management Commands
+
+```python
+from winipedia_utils.django.command import ABCBaseCommand
+
+class MyCommand(ABCBaseCommand):
+    """Custom Django command with built-in logging and validation."""
+
+    help = "Process data with automatic logging and error handling"
+
+    def add_command_arguments(self, parser):
+        parser.add_argument('--batch-size', type=int, default=1000)
+
+    def handle_command(self, *args, **options):
+        # Command logic with automatic logging and performance tracking
+        batch_size = options['batch_size']
+        self.stdout.write(f"Processing with batch size: {batch_size}")
+```
+
+### String Utilities
+
+```python
+from winipedia_utils.text.string import (
+    value_to_truncated_string,
+    ask_for_input_with_timeout,
+    get_reusable_hash
+)
+
+# Safely truncate any value to string
+truncated = value_to_truncated_string(large_object, max_length=100)
+
+# Get user input with timeout
+try:
+    user_input = ask_for_input_with_timeout("Enter value: ", timeout=30)
+except TimeoutError:
+    print("Input timeout exceeded")
+
+# Generate consistent hashes
+hash_value = get_reusable_hash("some data")
+```
+
+### Iterating Utilities
+
+```python
+from winipedia_utils.iterating.iterate import get_len_with_default
+
+# Safe length operations with fallback
+length = get_len_with_default(some_iterable, default=0)
+
+# Works with generators and other iterables that don't support len()
+gen = (x for x in range(100))
+safe_length = get_len_with_default(gen, default=100)
+```
+
+### Advanced OOP Features
+
+```python
+from winipedia_utils.oop.mixins.meta import ABCImplementationLoggingMeta
+
+class MyClass(metaclass=ABCImplementationLoggingMeta):
+    """Class with automatic logging and implementation enforcement."""
+
+    def my_method(self):
+        # Automatically logged with performance tracking
+        return "result"
+```
+
+## 🔮 Future Vision
+
+Winipedia Utils is designed to scale into a comprehensive ecosystem covering many utilities
+
+## 🛡️ Development Standards
+
+### Automated Quality Assurance
+
+Every utility in the ecosystem benefits from:
+
+- **🧪 100% Test Coverage Scaffolding**: Automated test generation ensures no function goes untested
+- **🔍 Static Type Checking**: MyPy ensures type safety across all utilities
+- **🎨 Code Formatting**: Ruff enforces consistent code style
+- **🔒 Security Scanning**: Bandit identifies potential security issues
+- **📝 Documentation Standards**: Consistent docstring patterns and examples
+
+### Pre-commit Hooks
+
+Automatically configured hooks ensure:
+- Code formatting with ruff
+- Type checking with mypy
+- Security scanning with bandit
+- Test generation and execution
+- Dependency validation
+See details in `winipedia_utils/git/pre_commit/hooks.py` and `winipedia_utils/git/pre_commit/run_hooks.py`
+
+## 🏗️ Project Structure
+
+```
+winipedia_utils/
+├── concurrent/          # Parallel processing utilities
+├── conventions/         # Testing and naming conventions
+├── data/               # Data science utilities (expanding)
+├── git/                # Git integration and workflows
+├── logging/            # Standardized logging configuration
+├── modules/            # Package/module introspection
+├── oop/                # Object-oriented programming enhancements
+├── os/                 # Operating system utilities
+├── projects/           # Project configuration (Poetry, etc.)
+├── testing/            # Automated test generation
+├── text/               # String and text processing
+└── setup.py           # Main setup script
+```
+
+## 🤝 Contributing
+
+Winipedia Utils welcomes contributions! The automated setup ensures that all contributions maintain high quality standards:
+
+1. Fork the repository
+2. Run `poetry run python -m winipedia_utils.setup` in your fork
+3. Add your utilities following the established patterns
+4. Tests are automatically generated - implement the test logic
+5. Pre-commit hooks ensure code quality
+6. Submit a pull request
+
+## 📄 License
+
+MIT License - see LICENSE file for details.
+
+---
+
+**Note**: All `_private_methods` are intended for internal use within the winipedia_utils package and cannot be used directly in external projects.
+

winipedia_utils-0.1.0.dist-info/RECORD

@@ -0,0 +1,64 @@
+winipedia_utils/__init__.py,sha256=vOWZ8n-YemVIzDLd8eWw1HVPGH3jxuT6VtDKHbmxk_A,43
+winipedia_utils/concurrent/__init__.py,sha256=Tu0ig4gVCk_f1n74G35hDwH-WS3P3STVQGWjxTIbbo8,54
+winipedia_utils/concurrent/concurrent.py,sha256=hzcODH-EIruKXKDqGSqtWV0UZb5n8HOVdkrT3FctOro,8645
+winipedia_utils/concurrent/multiprocessing.py,sha256=18MapAuhN3rtHQQZ3vvQ3wb_erYkO74T9UWUCjXPOzc,4386
+winipedia_utils/concurrent/multithreading.py,sha256=myrHoSSc6UW86SdCz1OksQcAcq29-2Rk7fa1wTT89BM,3177
+winipedia_utils/consts.py,sha256=P-VbaPvjNockqppQ9cjSIEzf8iXzeEUHcVRaMOyGCCI,518
+winipedia_utils/data/__init__.py,sha256=9RZFoceil00La5TyNM1baF-fjfAKKV22auLSxvJ_QD0,49
+winipedia_utils/data/dataframe.py,sha256=7rRy4LDv-4bJeISUPsxrQqTiFI7ENSzk4gKaVgTWD04,281
+winipedia_utils/django/__init__.py,sha256=ZnI3rINKvT4m9K3eeGg9RVBjBPH73zaBhb0Qy4hLt5g,683
+winipedia_utils/django/bulk.py,sha256=7MLfq83xanxbVFo4ANdtcYv5S-oQwdrNkH5ljPzjKLM,20375
+winipedia_utils/django/command.py,sha256=ENEg_crSbnm3nQIks-j2DjjAfeZ7ppJkZOyw__IpSYw,13824
+winipedia_utils/django/database.py,sha256=tH8AA5LTMYY-co8R_pI6xs0SrmJqjrOEJUJdnWc4TBE,11487
+winipedia_utils/git/__init__.py,sha256=pPo5DDqaQkFim8L6x22DXjqthLnKAxLyXlXl7JXGUdw,48
+winipedia_utils/git/gitignore.py,sha256=iliNf_FBfcnyGW2zjoh1yg5fOVvSAISt9vOJb10rAUs,2551
+winipedia_utils/git/pre_commit/__init__.py,sha256=2sBe5nOqmm3qb8YjhZzE4tCHhqxWOZ6R2ECljSVG7i4,59
+winipedia_utils/git/pre_commit/config.py,sha256=MUgk-43kd5l0cRk9VKzMQl88bDodsN8rSZcMzSzPpQw,1959
+winipedia_utils/git/pre_commit/hooks.py,sha256=Q6rXvbpUf9UasQ8vSBruoLA-wjm37jamvIUkXJ1B3FE,3210
+winipedia_utils/git/pre_commit/run_hooks.py,sha256=WoF1WDr07mS2GpKt0M-TpnuWfS0-Hwa4tP6z_9-JqlU,1572
+winipedia_utils/iterating/__init__.py,sha256=TZ0SSFA3zCJLk0z3IsLMxJqsfGzfxOSUKbQmwW-Dsqg,54
+winipedia_utils/iterating/iterate.py,sha256=IpV710BS5fBPSzwZTTJLUqEhSHT-gmnQxMg3uEt85CA,973
+winipedia_utils/logging/__init__.py,sha256=AMt1LwA_E7hexYjMpGzUempoyDdAF-dowWvq59wC5aM,51
+winipedia_utils/logging/ansi.py,sha256=54MIYKppssv-TBFavOAi28aCo4Cg--cChTzdjGsBXJY,107
+winipedia_utils/logging/config.py,sha256=NAXCxVRkEfkf119HCg1zrdP1l37DW4cFDHvKrBEjQ0o,2959
+winipedia_utils/logging/logger.py,sha256=tCcUwAVLVr3Bec7_i-SoKvBPNCJSEmyuvBW2gbqjPMk,727
+winipedia_utils/modules/__init__.py,sha256=e3CFaC3FhK4ibknFOv1bqOZxA7XeVwmLqWX7oajUm78,51
+winipedia_utils/modules/class_.py,sha256=RDjal6QYYs9z81DT1mIFrnEhQ9vgN2tCAYN1WWnN24Y,2462
+winipedia_utils/modules/function.py,sha256=Qn1OPV5dwO-7f3a0f0RpWcrH-E9teGPwldRtwbFYzRM,2551
+winipedia_utils/modules/module.py,sha256=iJwUJPhVkxyRjJqHVVWh3GNJFiYf45ZdSfR21puQAmw,12673
+winipedia_utils/modules/package.py,sha256=CKyeT4Pb2KBzpCM-tHxnC1kq6XvU7W7pWLz1W-wJiv0,12245
+winipedia_utils/oop/__init__.py,sha256=wGjsVwLbTVEQWOfDJvN9nlvC-3NmAi8Doc2xIrm6e78,47
+winipedia_utils/oop/mixins/__init__.py,sha256=PDK-cJcdRUfDUCz36qQ5pmMW07G133WtN49OpmILGNI,54
+winipedia_utils/oop/mixins/meta.py,sha256=UpHags1j80OABxW4Q3QYt7A7lLIArvgUrGcWeYJaRyU,10576
+winipedia_utils/oop/mixins/mixin.py,sha256=GuYdeueiOIHoRi9ds2ztxUcLnrcsBhHAsbrO43N9AGg,1170
+winipedia_utils/os/__init__.py,sha256=WSLt7tb6HqWRlCGGIEwRfVksF0sLJNeEW3iZeJhGWk0,47
+winipedia_utils/os/os.py,sha256=ITuiLLfjGBV2jH8tHQfwVzsICT-jY1zUxtwu3ASJBG4,1690
+winipedia_utils/projects/__init__.py,sha256=6oTiSlUMAwO5xnH4SGVnvspzKcxrxo9kn1L4xkjq1p8,53
+winipedia_utils/projects/poetry/__init__.py,sha256=0yNMuu9KmM19od4VBxBV3HLK-RdCsa0e2Zhg33J7RmQ,60
+winipedia_utils/projects/poetry/config.py,sha256=r8sbhsF26yro5qLg2srjl3s9MftwEbfmE2F9bAFA58E,2976
+winipedia_utils/projects/poetry/poetry.py,sha256=5jyUSMxhCZ7pz9bOaz5E9r7Da9qIrGOp6wcBzI1y7Cg,932
+winipedia_utils/setup.py,sha256=ozdPXwHBRWLSiL2xLfbWnRZ_OHl560eKgP8e94cuDAM,1280
+winipedia_utils/testing/__init__.py,sha256=kXhB5xw02ec5xpcW_KV--9CBKdyCjnuR-NZzAJ5tq0g,51
+winipedia_utils/testing/assertions.py,sha256=0JF4mqVTnLQ1qkAL_FuTwyN_idr00rvVlta7aDdnUXA,851
+winipedia_utils/testing/convention.py,sha256=NxC_hYaUXshsa6LL6nQoEEKpTzC1KwTloKL8aS2gUPI,5010
+winipedia_utils/testing/create_tests.py,sha256=9SrmzyMD7yPKCoLKkM0i_wRASHw2hJ_61sNuvZtYmt4,9820
+winipedia_utils/testing/fixtures.py,sha256=e0ax1n1zqzmLawA26k0EtNa3rYSMu10lMNVRjBuIGMs,1061
+winipedia_utils/testing/tests/__init__.py,sha256=kL-1O6lAO5j4JPOqPdi3dHdbOQ_UXcgPFppj82HhrRU,57
+winipedia_utils/testing/tests/base/__init__.py,sha256=dBH1yfONmqUC49zshS6BJ4ZgEcw7iFGoFCqRmU7Vhrw,62
+winipedia_utils/testing/tests/base/fixtures/__init__.py,sha256=CeRM8RSAA1UnH81OI09ZgGWxryUDvDz6gSahGa-U2hI,72
+winipedia_utils/testing/tests/base/fixtures/fixture.py,sha256=-MHvMCwLJwJrkie7fgVIhFA_nt-fp0-KfiisERcHb_E,187
+winipedia_utils/testing/tests/base/fixtures/scopes/__init__.py,sha256=-n_BLhTVC1oH7qVL0JYXm82zqFPgobQCojO-PirrKo0,78
+winipedia_utils/testing/tests/base/fixtures/scopes/class_.py,sha256=XCx4HZeHbJJ-C7wGsi5bQx7nPGTuAI3xhHp1FpGeom8,1133
+winipedia_utils/testing/tests/base/fixtures/scopes/function.py,sha256=5dW7-IPqJ_3Q2j1vftZL5FYKvNSKufqiHzLTTWYhja4,309
+winipedia_utils/testing/tests/base/fixtures/scopes/module.py,sha256=V0H9WFrdSV7uj__bXM_GKcCJnjResqI7fFjcxyvNaZk,1169
+winipedia_utils/testing/tests/base/fixtures/scopes/package.py,sha256=IKOfj6vfyjEQdRV5cJoPRQvALmePpGxWkGy23di00-w,309
+winipedia_utils/testing/tests/base/fixtures/scopes/session.py,sha256=dd8QRSV_zJpz6_r0Xinryar-ciblFxszn0Bh5p2I6Pw,7652
+winipedia_utils/testing/tests/base/utils/__init__.py,sha256=mC-8dCkp8xarqkQu2QQLrPjHi6Ww9hcixWdHeQHWeRs,68
+winipedia_utils/testing/tests/base/utils/utils.py,sha256=dUPDrgAxlfREQb33zz23MfzacLLuwjy2AO-PQQp_aSI,2820
+winipedia_utils/testing/tests/conftest.py,sha256=CvLtsr-KhSPzbQYin6SYZQC1Ez3AzIsqCWhuLuXinAs,826
+winipedia_utils/text/__init__.py,sha256=j2bwtK6kyeHI6SnoBjpRju0C1W2n2paXBDlNjNtaUxA,48
+winipedia_utils/text/string.py,sha256=1jbBftlgxffGgSlPnQh3aRPIr8XekEwpSenjFCW6JyM,3478
+winipedia_utils-0.1.0.dist-info/LICENSE,sha256=3PrKJ2CWNrnyyHaC_r0wPDSukVWgmjOxHr__eQVH7cw,1087
+winipedia_utils-0.1.0.dist-info/METADATA,sha256=_mORtARL4qiNjHVQRf-1FtpYsFmKFhruGwGSa5kzPzg,12311
+winipedia_utils-0.1.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+winipedia_utils-0.1.0.dist-info/RECORD,,

winipedia_utils-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.1.3
+Root-Is-Purelib: true
+Tag: py3-none-any