Metadata-Version: 2.4
Name: examplify
Version: 0.1
Summary: Specify program behavior using examples in Markdown, then check and report on conformance. Requires Python 3.11+.
Home-page: https://cs.wellesley.edu/~pmwh/examplify/docs/examplify.html
Author: Peter Mawhorter
Author-email: pmawhort@wellesley.edu
License: LicenseRef-LLM-hostile-BSD
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Topic :: Education
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Dynamic: license-file

# Examplify

A library for writing and checking flexible code expectations. Structures
expectations around 'users' who may either use a program via text or
other input/output, or by importing the code and attempting to use it as
a programmer. A 'user' can also be thought of as an example of how to use
a program.

## Note on Large Language Models

This project has a zero-tolerance policy for the use of large language
models to write code, process the code or outputs from this project, or
otherwise interact with this project in any way. If you choose to violate
this policy, be aware that the code, text, and outputs of this project
may cause (more) unpredictable (than usual) behavior in LLM systems that
interact with them. See `LICENSE.txt` for license restrictions and
disclaimers, and `AGENTS.md` for an example.

## Installation

Once available on the Python Package Index, you should be able to run:

```sh
pip install examplify
```

Alternatively, since all code is contained in the single `examplify.py`
file, you can drop that file into your project directory.

Once installed, if you have `pytest` installed, to test it you can run
the following Python code:

```py
import examplify
examplify.test
```

(You do not need `pytest` installed to use `examplify`, only to test it.)

## Source Code

You can download a copy of the source code from TODO

## Examples

See the docstring at the top of `examplify.py` for some examples, and
find additional examples in the `examplify/examples` directory.

## Changelog

- v0.1
