Skip to main content

Rising Storm 2: Vietnam WebAdmin Python Interface

Project description

rs2wapy

Discord Travis Maintainability

Rising Storm 2: Vietnam WebAdmin Python Interface

Provides a Python interface for performing RS2 WebAdmin tasks programmatically.

The library uses PycURL internally to communicate with RS2 WebAdmin.

Work in progress; interface will change!

Brief Usage Examples

This section contains some brief usage examples. For more comprehensive tutorials check out the examples repository.

Installation
# Requires Python=>3.7
pip install rs2wapy
Steam Web API key (optional)

Setting your Steam Web API key as an environment variable allows rs2wapy to offer some extra functionality.

Unix:

export STEAM_WEB_API_KEY="TOPSECRETKEY"

Windows:

set STEAM_WEB_API_KEY="TOPSECRETKEY"
Quickstart

It is recommended to create a new WebAdmin account for rs2wapy.

from rs2wapy import RS2WebAdmin

wa = RS2WebAdmin(
    username="AutoModerator",
    password="topsecret123",
    webadmin_url="http://localhost:8080/",
)
Poll server ranked status and switch map automatically
while True:
    if not wa.get_current_game().ranked:
        wa.post_chat_message("Unranked bug happened! Changing map in 5 seconds!")
        time.sleep(5)
        wa.change_map("VNTE-Resort")
    time.sleep(1)

The above is just a single example of how to use the library. In the future, the library will be able to automate all tasks which RS2 WebAdmin offers. You can check the status of currently implemented WebAdmin features here: https://github.com/tuokri/rs2wapy/issues/9.

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

rs2wapy-0.6.3.tar.gz (44.1 kB view details)

Uploaded Source

Built Distribution

rs2wapy-0.6.3-py3-none-any.whl (31.1 kB view details)

Uploaded Python 3

File details

Details for the file rs2wapy-0.6.3.tar.gz.

File metadata

  • Download URL: rs2wapy-0.6.3.tar.gz
  • Upload date:
  • Size: 44.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.0

File hashes

Hashes for rs2wapy-0.6.3.tar.gz
Algorithm Hash digest
SHA256 c0e2b30c29148d13838b6f76ca6d7e60c70a4d201e6954a5d3614f8d9be2f964
MD5 40e592b7ef5035ca27fd60af6c0bf80b
BLAKE2b-256 130a0c40a2977c3ad81013c4b5883120233b694132d703c9731870a5d1d20754

See more details on using hashes here.

File details

Details for the file rs2wapy-0.6.3-py3-none-any.whl.

File metadata

  • Download URL: rs2wapy-0.6.3-py3-none-any.whl
  • Upload date:
  • Size: 31.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.1.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.0

File hashes

Hashes for rs2wapy-0.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f3d378f0308e9a118bad6fb7a089adf5738f8e4bc0a9855f9d93a5eb23da0d86
MD5 88b3291bac52fc1027c65612ad764853
BLAKE2b-256 14d9635a8145f7b9116141457f0fc9d0b8c8229241a1b69480acaa840273b752

See more details on using hashes here.

Supported by

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