Skip to main content

Library for simplified access to the Gerstlix API

Project description

pip install gerstlix_python

What is this?

Library for simplified access to the Gerstlix API

Quick Guide

To access the methods of the module, you need to:

from gerstlix_python import *
gx = gerstlixAPI(token="your_token")

Example

from gerstlix_python import *
gx = gerstlixAPI(token="your_token")

result = gx.get_members(server=3, fractionId=1)
print(result)

Output

{
    "serverId": 1, 
    "serverName": "serverName", 
    "fractionId": 1, 
    "fractionName": "fractionName", 
    "playersLastUpdate": "2023-10-13 13:03:40", 
    "playersCount": 1, 
    "playersInfo": [
        {
            "nickname": "nickname", 
            "accountId": 1, 
            "rang": 1, 
            "rankLabel": "rankLabel", 
            "isLeader": true, 
            "isOnline": false, 
            "gameId": -1, 
            "level": -1
        }
    ]
}

Currently available methods

.get_leader             : params = server, fractionId | return => json
.get_deputy             : params = server, fractionId | return => json
.get_members            : params = server, fractionId | return => json
.get_minister           : params = server, fractionId | return => json
.get_record_fraction    : params = server, fractionId | return => json
.get_status             : params = gameProject        | return => json
.get_info               : params = server             | return => json 
.get_ghetto_territories : params = server             | return => json
.get_old_players        : params = server             | return => json
.get_rich_players       : params = server             | return => json
.get_deputies           : params = server             | return => json
.get_leaders            : params = server             | return => json
.get_minister_list      : params = server             | return => json
.get_records            : params = server             | return => json
.get_ip                 : params = ip                 | return => json
.check_work_methods     : params = None               | return => json
.count_methods          : params = None               | return => int

Types of parameters

server       : INTEGER
fractionId   : INTEGER
gameProject  : STRING [ arz, marz, rrp ]
ip           : IPv4
----------------------------------------
arz          : Arizona Role Play
marz         : Mobile Arizona Role Play
rrp          : Rodina Role Play

Other information

Gerstlix site The module is specially designed for Gerstlix

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

gerstlix_python-0.2.8.tar.gz (3.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gerstlix_python-0.2.8-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

Details for the file gerstlix_python-0.2.8.tar.gz.

File metadata

  • Download URL: gerstlix_python-0.2.8.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.4 Windows/10

File hashes

Hashes for gerstlix_python-0.2.8.tar.gz
Algorithm Hash digest
SHA256 cdcad0a01ca67e098ab0ec7bcec4ac403735bf7fdc192a5cd4473d0e52caaf3a
MD5 a1e6858dd8d93792a7397944d8c8c471
BLAKE2b-256 eb3f24b84eb634d8099ffe0b61001dc395cceb2887a4ab1803ff99cca599c8ab

See more details on using hashes here.

File details

Details for the file gerstlix_python-0.2.8-py3-none-any.whl.

File metadata

  • Download URL: gerstlix_python-0.2.8-py3-none-any.whl
  • Upload date:
  • Size: 3.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.4 Windows/10

File hashes

Hashes for gerstlix_python-0.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 c869f33fd2dbb783f37fa5ec5ffcf2800905cc17c301dc6ced380d8e9283035c
MD5 b1a14815ce53f05964572c5b8d043d79
BLAKE2b-256 feee80b62315dbee3c89e5df4002668c869acef482b55f2487323b512e23d25b

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