Metadata-Version: 2.4
Name: teaching_sim_eval
Version: 0.1.3
Summary: Evaluating in-classroom teaching simulations leveraging the power of large language models.
Home-page: https://github.com/xrtze/teaching_sim_eval
Author: Jami Schorling
Author-email: js68jynu@uni-leipzig.de
License: CC BY-NC 4.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: faicons==0.2.2
Requires-Dist: groq==0.20.0
Requires-Dist: jinja2==3.1.6
Requires-Dist: keyring==25.6.0
Requires-Dist: matplotlib==3.10.1
Requires-Dist: openai==1.93.0
Requires-Dist: pandas==2.2.3
Requires-Dist: pyparsing==3.2.1
Requires-Dist: python-docx==1.1.2
Requires-Dist: shiny==1.4.0
Provides-Extra: dev
Requires-Dist: twine>=4.0.2; extra == "dev"
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Shiny Web Application

This is an open-source, platform independent webapp for evaluating the performance of teaching students during class room simulation, leveraging the power of Large Language Models (LLMs). It will provide both quantitative and qualitative reports of the verbal classroom performance and allows for customization of the analysis parameters. It was built Shiny for Python web application. It provides an interactive web interface for users to engage with data and visualizations.
An API-Key for either OpenAI or groq is required to perform qualitative analysis.

## Installation
Install via pip install teaching-sim-eval

## Usage

To run the Shiny web application, from terminal simply run

```
teaching-sim eval
```

or 
```
python -m teaching-sim-eval
```

Once the application is running, it will automatically open the interface in your webbrowser at `http://localhost:5000`.

## Contributing

Contributions are welcome! Please submit a pull request or open an issue for any enhancements or bug fixes on github.

## License

This project is licensed under the CC BY-NC 4.0 License. See the LICENSE file for more details. Let's socialize software for the open-source democratic stack! 
