SA-MP API client for python supporting both query and RCON APIs
Project description
GTA SA-MP client
RCON and query client library for Python
A modern Python library for querying and managing SA-MP servers.
Supported Python version 3.4 or newer. If you require support for Python 2.7, install 2.1 version of the package.
Installation
pip install samp-client
Usage
The library can be easily interfaced using a single SampClient
class:
from samp_client.client import SampClient
with SampClient(address='localhost', port=7777) as client:
print(client.get_server_info())
The library also allows you to run RCON commands as well as queries:
from samp_client.client import SampClient
with SampClient(address='localhost', port=7777, rcon_password='password') as client:
client.rcon_cmdlist()
Query and RCON responses are parsed into native Python structures:
from samp_client.client import SampClient
with SampClient(address='localhost', port=7777, rcon_password='password') as client:
info = client.get_server_info()
print(info)
# ServerInfo(password=True, players=9, max_players=100, hostname='Convoy Trucking', gamemode='Convoy Trucking 3.1.1', language='English')
print(info.gamemode)
# 'Convoy Trucking 3.1.1'
print(client.rcon_get_hostname())
# ServerVar(name='hostname', value='Convoy Trucking', read_only=False)
print(client.rcon_players()[0].ping)
# 26
Examples
Folder example/
contains usage example of the library
Running tests
To run tests:
python -m unittest discover -v
Project details
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
Built Distribution
File details
Details for the file samp-client-3.0.1.tar.gz
.
File metadata
- Download URL: samp-client-3.0.1.tar.gz
- Upload date:
- Size: 6.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
41e65cedd0b511bd6c19e385daa44f179fc988fb8848df1b969588bd70dbb94e
|
|
MD5 |
d1e8da8464aeec01a1ce7c24c766ccb2
|
|
BLAKE2b-256 |
c479e1c20961a12e64799c0bda4f0c597693e16025ac2a4df0f5684cfc26c7b3
|
File details
Details for the file samp_client-3.0.1-py3-none-any.whl
.
File metadata
- Download URL: samp_client-3.0.1-py3-none-any.whl
- Upload date:
- Size: 9.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
344c4dadd59104f7fa761ca130cf049fb865b8a889a8b900dbd789b8e89f96ca
|
|
MD5 |
ca0c675c9c24e765e745a9e6a32f113f
|
|
BLAKE2b-256 |
ef4b8db1d6e0fc221e57795d415eb77a0424a3cd20af217fdaafb0040b92b388
|