Metadata-Version: 2.1
Name: cpanel-api
Version: 0.1.1
Summary: CPanel API Client. Supports latest UAPI.
Home-page: https://github.com/tz4678/cpanel-api
Author: Sergey M
Author-email: tz4678@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown

# CPanel API Client for Python

Supports only UAPI.

```zsh
$ pip install cpanel_api
```

Examples:

```python
#!/usr/bin/env python
# -*- coding: utf-8 -*-
import logging
import sys

from cpanel_api import *

logging.basicConfig(level=logging.DEBUG, stream=sys.stderr)

hostname = 'HOSTNAME_OR_IP_ADRESS'
username = 'USERNAME'
password = 'PASSWORD'

client = CPanelClient(hostname, username, password)

client.Module.function({'param': 'value'}, param='value')
client.api('Module', 'function', {'param': 'value'}, param='value')

res = client.SSH.get_port()
# {
#     'data': {'port': '1243'},
#     'errors': None,
#     'metadata': {},
#     'warnings': None,
#     'messages': None,
#     'status': 1,
# }
print(res.data.port)
```

Links:

- [Official documentation](https://documentation.cpanel.net/display/DD/Guide+to+UAPI).

