Skip to main content

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 2.7, 3.4, 3.5 and 3.6

Installation

pip install samp-client-es

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.

Source Distribution

query-client-silverbullet-s-1.0.1.tar.gz (7.0 kB view details)

Uploaded Source

File details

Details for the file query-client-silverbullet-s-1.0.1.tar.gz.

File metadata

  • Download URL: query-client-silverbullet-s-1.0.1.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.7.7

File hashes

Hashes for query-client-silverbullet-s-1.0.1.tar.gz
Algorithm Hash digest
SHA256 09533b188e9f4d9551a4d1415f69e84aaae41da549740de86c9ad7cada53aa7f
MD5 dc140513fed5c1bc13b97a4355d8f54d
BLAKE2b-256 085d3d7f345c24ce8ecb61224a7ef683d80f0949528bf7513e1dd1a7ca24bae8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page