Sync and Async Object-oriented Python SDK for the 3x-ui app.
Project description
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
pip install py3xui
Quick Example
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
pytest
mypy py3xui
pylint py3xui
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
py3xui-0.7.0.tar.gz
(38.1 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
py3xui-0.7.0-py3-none-any.whl
(45.8 kB
view details)
File details
Details for the file py3xui-0.7.0.tar.gz.
File metadata
- Download URL: py3xui-0.7.0.tar.gz
- Upload date:
- Size: 38.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b706bed1431926273213d663ff89c4507d4dbc91777ec3ff4e5f4c8d2ca7fafc
|
|
| MD5 |
e347dacdd1f066210c933ec703679974
|
|
| BLAKE2b-256 |
a4be08d75617362dd7a2bd250fa37902c628a638a116072753e56debb36bfc9e
|
File details
Details for the file py3xui-0.7.0-py3-none-any.whl.
File metadata
- Download URL: py3xui-0.7.0-py3-none-any.whl
- Upload date:
- Size: 45.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
866bef26ab4b35143abee0bd0dbbd82a49f79162a2df951ec4f9f5d5ee38e088
|
|
| MD5 |
ddf3f4ab055d9f9471c8bfbc9242ad9f
|
|
| BLAKE2b-256 |
26a6dc1e5cd9219a309fbb01566dae85dd68a7f22da6ecdfe5ef18793b38b85e
|
