Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for samp-client, version 3.0
Filename, size File type Python version Upload date Hashes
Filename, size samp_client-3.0-py3-none-any.whl (9.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size samp-client-3.0.tar.gz (6.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page