Metadata-Version: 2.4
Name: untis
Version: 0.1.0rc2
Author-email: IceWizard7 <mrrioes.dc@gmail.com>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/IceWizard7/untis
Project-URL: Documentation, https://github.com/IceWizard7/untis
Project-URL: Source, https://github.com/IceWizard7/untis
Project-URL: Issues, https://github.com/IceWizard7/untis/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests~=2.32.5
Requires-Dist: colorama~=0.4.6
Requires-Dist: playwright~=1.58.0
Dynamic: license-file

<br/>
<div align="center">
  <h3 align="center">🕞 Untis</h3>

  <p align="center">
    Python library for interacting with WebUntis
    <br />
    <br />
    <a href="#1-installation">Installation</a> •
    <a href="#2-quickstart">Quickstart</a> •
    <a href="#3-documentation">Documentation</a> •
    <a href="#4-license">License</a>
  </p>
</div>

<div align="center">
  <img src="image_examples/example_placeholder.png" alt="Example Image of Untis" width="250">
</div>
<br>

> Note: Teacher names have been replaced with placeholder numbers for privacy.

![PyPI Version](https://img.shields.io/pypi/v/untis)
![Python Versions](https://img.shields.io/pypi/pyversions/untis)
![License](https://img.shields.io/pypi/l/untis)
![Downloads (all time)](https://static.pepy.tech/badge/untis)
![Downloads (last month)](https://static.pepy.tech/badge/untis/month)

> [!CAUTION]
> More documentation will follow soon.

## 1. Installation

`pip install untis`

## 2. Quickstart

```python
import untis

global_session = untis.objects.Session(
    'global_session',
    use_cache=False,
    cache_file=None,
    logger=None,
    username='insert_your_username',
    password='insert_your_password',
    server='insert-your-school.webuntis.com/WebUntis',
    school='insert-your-school',
    client='WebUntis Test'
)

for klasse in global_session.all_klassen():
    print(klasse.name)
```
[read more...](docs/index.md)

## 3. Documentation

See [Index](docs/index.md) for full usage and API details.

## 4. License

See [License](LICENSE).
