Metadata-Version: 2.4
Name: py3xui
Version: 0.7.0
Summary: Sync and Async Object-oriented Python SDK for the 3x-ui app.
Author-email: iwatkot <iwatkot@gmail.com>
License: MIT License
Project-URL: Homepage, https://github.com/iwatkot/py3xui
Project-URL: Repository, https://github.com/iwatkot/py3xui
Keywords: vpn,3x-ui,sdk,api
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: pydantic>=2.0.0
Requires-Dist: requests>=2.0.0
Requires-Dist: httpx>=0.20.0
Requires-Dist: mypy>=2.1.0
Dynamic: license-file

# py3xui

Python SDK for 3x-ui with synchronous and asynchronous clients.

## Documentation

Project documentation is now maintained in GitBook-ready format under the `docs/` directory.

- Start here: `docs/README.md`
- Table of contents: `docs/SUMMARY.md`
- 0.7.0 release notes: `docs/release-notes/0.7.0.md`

## Install

```bash
pip install py3xui
```

## Quick Example

```python
from py3xui import Api

api = Api("http://your-3x-ui-host:2053", "username", "password")
api.login()
status = api.server.get_status()
print(status)
```

## Development Checks

```bash
pytest
mypy py3xui
pylint py3xui
```
