Metadata-Version: 2.4
Name: hubify-core
Version: 0.1.0
Summary: Composable survey question models with hierarchical namespaces
License: MIT License
        
        Copyright (c) 2025 Hubify
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        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 OR COPYRIGHT HOLDERS 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.
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: pydantic<3,>=2.7
Description-Content-Type: text/markdown

# Hubify

Hubify is a Python package that provides composable survey question models with a
lazy-loaded, hierarchical namespace. The library focuses on:

- A consistent set of `BaseQuestionContract` abstractions powered by
	[Pydantic v2](https://docs.pydantic.dev/latest/).
- Category-specific implementations such as simple, multiple, matrix, and advanced
	questions that automatically register themselves.
- A `QuestionFactory` capable of instantiating question payloads dynamically based on
	their `question_type` metadata.

The runtime package lives under `src/hubify/` and is published on PyPI as the
`hubify-core` distribution while remaining importable via the `hubify` module.

## Getting Started

The project uses [uv](https://github.com/astral-sh/uv) for dependency
management. To install all dependencies:

```bash
uv sync
```

Run the test-suite with:

```bash
uv run pytest
```

To enter a REPL or execute scripts against the synced environment use
`uv run <command>`.

## Package Layout

```
src/hubify/
├── __init__.py        # Package exports and conveniences
├── surveys.py         # Survey composition model
└── questions/
		├── __init__.py    # Lazy-loading namespace + public API
		├── registry.py    # Auto-discovery registry and factory helpers
		├── contracts/     # Base contracts and shared models
		└── types/         # Question implementations grouped by category
```

Documentation describing the architecture and import patterns lives under
`docs/`. Tests validating lazy-loading behaviour and question contracts live in
`tests/`.
