Metadata-Version: 2.4
Name: mchost24
Version: 1.0.0
Summary: A Python Module that allows interacting with the MC-Host24 REST API
Author-email: JoeJoeTV <joejoetv@joejoetv.de>
License-Expression: GPL-3.0
Project-URL: Homepage, https://github.com/JoeJoeTV/mchost24-api-python
Project-URL: Issues, https://github.com/JoeJoeTV/mchost24-api-python/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: System :: Networking
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: dataclasses_json>=0.6.6
Requires-Dist: pytimeparse2>=1.7.1
Requires-Dist: requests>=2.32.3
Dynamic: license-file

# MC-Host24 Python API

A Python Module that allows interacting with the [MC-Host24](https://mc-host24.de) REST API.

## Installation

The package can be installed by cloning the repository and executing the following command in the directory:

```sh
pip install .
```

## Usage

The module `mchost24.api` contains the dataclasses, types, etc. used by the API and the class `MCHost24API` can be used to interact with the REST API.
The class requires an API key for most of the functionality. This API key can be generated using the API key manager (see below).

## API Key Manager

By executing the module with the sub command `manage`, the API key manager can be opened:

```sh
python -m mchost24 manage
```

This manager allows the generation of new API keys using the user's credentials and the invalidation of existing API keys
