Metadata-Version: 2.4
Name: codecraftai-xmodules
Version: 1.3.1
Summary: Code Craft AI - Python Extension Modules
License-Expression: LicenseRef-CodeCraftAI-Source-Available
License-File: LICENSE.md
Keywords: python
Author: Myron Walker
Author-email: myron.walker@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX
Requires-Dist: codecraftai-foundations (>=1.0.0,<2.0.0)
Requires-Dist: debugpy (>=1.8.14,<2.0.0)
Project-URL: Issues, https://github.com/code-craft-ai-company/codecraftai-xmodules/issues
Project-URL: Repository, https://github.com/code-craft-ai-company/codecraftai-xmodules
Description-Content-Type: text/x-rst

==========================================
CodeCraftAI XModules Overview
==========================================

The ``codecraftai-xmodules`` package contains utility modules that extend
standard Python libraries. Each module name begins with ``x`` to avoid
collisions with the Python modules they extend.

Provided Extensions
-------------------

- **xcollections** – Case-insensitive dictionaries and context management helpers for shared automation state.
- **xconvert** – Safe string/bytes conversions and boolean parsing.
- **xdatetime** – Convenience functions for timestamps and formatted time strings.
- **fspath** – Path expansion helpers that combine common filesystem path operations.
- **xformatting** – Utilities for indenting multi-line text and formatting command results.
- **ximport** – Functions to import modules dynamically by name or from a file.
- **xinspect** – Helpers for introspecting functions and modules at runtime.
- **xlogging** – Components to simplify logging setup, log levels and monitored execution scopes.
- **xmuliprocessing** – Support for capturing stdout/err from child processes using a piped process abstraction.
- **xpython** – Helpers for manipulating the Python search path in running processes.
- **xthreading** – Thread utilities including a worker "Looper" pool and synchronization primitives such as read/write locks.
- **xzipfile** – Helper for creating zip archives of folders.

These modules are located under ``source/packages/ccai/xmodules`` and are used throughout Code Craft AI projects.

=================
Code Organization
=================
* .vscode - Common tasks
* development - This is where the runtime environment scripts are located
* repository-setup - Scripts for homing your repository and machine setup
* userguide - Where you put your user guide
* source/packages - Put your root folder here 'source/packages/(root-module-folder)'
* workspaces - This is where you add VSCode workspaces templates and where workspaces show up when homed.

==========
References
==========

- `User Guide <userguide/userguide.rst>`
- `Coding Standards <userguide/10-00-coding-standards.rst>`

