Metadata-Version: 2.4
Name: codecraftai-runtime
Version: 1.2.0
Summary: Code Craft AI - Runtime
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-this-app (<2.0.0)
Project-URL: Issues, https://github.com/code-craft-ai-company/codecraftai-runtime/issues
Project-URL: Repository, https://github.com/code-craft-ai-company/codecraftai-runtime
Description-Content-Type: text/x-rst

========================
Code Craft AI Runtime
========================

The ``codecraftai-runtime`` package provides the runtime-configuration and activation layer that codecraftai-based applications and tools share. It is responsible for establishing logging, runtime variables, and well-known paths early in a process's lifecycle so that downstream packages can rely on a consistent environment regardless of whether the caller is a CLI, a service, or a test runner.

Highlights
==========

This package is being retired: the runtime foundation has moved into ``ccai.thisapp``
as part of the testbase / integration-runtime refactor. Four of its modules are now
TEMPORARY compatibility shims that re-export from ``ccai.thisapp`` so existing importers
keep working during the migration; ``optionoverrides.py`` is the only remaining
first-party implementation.

- ``activation.py`` - compatibility shim re-exporting ``ccai.thisapp.activation``.
- ``runtimevariables.py`` - compatibility shim re-exporting ``ccai.thisapp.runtimevariables``.
- ``enumerations.py`` - compatibility shim re-exporting ``ccai.thisapp.enumerations``.
- ``paths.py`` - compatibility shim re-exporting ``ccai.thisapp.paths``.
- ``optionoverrides.py`` - first-party CLI-level option overrides (``AM_RUNTIME_OPTION_OVERRIDES``).

Repository Structure
====================

- ``development/`` - Runtime environment scripts.
- ``repository-setup/`` - Repository homing and setup scripts.
- ``source/packages/`` - Package source code.
- ``source/tests/`` - ``unittest``-based tests.
- ``specs/`` - Requirements, design, and task documentation.
- ``userguide/`` - Standards, conventions, and documentation.

Environment Setup
=================

When working in a Codex container:

.. code-block:: bash

   ./development/setup-agent-container

For local development:

.. code-block:: bash

   ./repository-setup/rehome-repository
   ./development/setup-envrionment

Running Tests
=============

Activate the virtual environment:

.. code-block:: bash

   source .venv/bin/activate

Run ``unittest`` tests:

.. code-block:: bash

   python -m unittest discover -s source/tests -p "test_*.py"

Standards and Conventions
=========================

- Naming conventions: ``userguide/10-02-naming-conventions.rst``
- Code organization: ``userguide/10-01-code-organization.rst``
- Coding standards: ``userguide/10-00-coding-standards.rst``

Additional Resources
====================

- User guide entry point: ``userguide/userguide.rst``
- Design documentation: ``specs/design.md``
- Requirements: ``specs/requirements.md``

