Metadata-Version: 2.4
Name: htmleval
Version: 0.1.6
Summary: A Python package that facilitates the creation of HTML evaluations.
Home-page: https://github.com/markusmobius/htmleval
Author: Markus Mobius
Project-URL: Bug Tracker, https://github.com/markusmobius/htmleval/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# HTMLEval documentation

**HtmlEval** is a framework for constructing **evaluation surveys** with reusable, structured **blocks**.

It enables the creation of **simple and complex survey layouts**, allowing users to:
- **Evaluate text**
- **Categorize content**
- **Interact with structured data**

## Installation

```bash
pip install git+https://github.com/markusmobius/htmleval
```

## Documentation

- **[Core Concepts](docs/concepts.md)**: Understand the difference between Simple and Compound blocks.
- **[Usage Guide](docs/usage.md)**: How to use the Python API to generate surveys.
- **[Simple Blocks](docs/simple_blocks.md)**: Documentation for Text, Questions, and other content blocks.
- **[Compound Blocks](docs/compound_blocks.md)**: Documentation for Layouts, Tabs, and Interactive blocks.

## Getting Started

To see a running example, generating the survey from the repository:

```bash
python createDemo.py
```

For a full example of creating evaluations, closing them, and generating a summary, see `createDemo5.py` and `createDemo5_summary.py`.
