Skip to main content

Python wrapper for the Oxford Response API

Project description

oxrpy

A Python wrapper for the Oxford RP API.

Installation

Install from PyPI:

pip install oxrpy Or from source:

pip install -r requirements.txt

Usage

from oxrpy import OxfordAPI

Initialize with your server ID and key

api = OxfordAPI(server_id="your_server_id", server_key="your_server_key")

Get server information

server_info = api.get_server() print(server_info)

Get current players

players = api.get_players() print(players)

Get queue

queue = api.get_queue() print(queue)

Get bans

bans = api.get_bans() print(bans)

Features

  • Automatic rate limiting (default 0.5s between requests)
  • Comprehensive error handling with custom exceptions
  • Request timeouts
  • Logging support
  • Input validation

API Endpoints

get_server(): Returns general server information. get_players(): Returns list of current players. get_queue(): Returns the reserved server queue. get_bans(): Returns active bans. All methods return the JSON response from the API.

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

oxrpy-0.5.0.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.

oxrpy-0.5.0-py3-none-any.whl (3.7 kB view details)

Uploaded Python 3

File details

Details for the file oxrpy-0.5.0.tar.gz.

File metadata

  • Download URL: oxrpy-0.5.0.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for oxrpy-0.5.0.tar.gz
Algorithm Hash digest
SHA256 d54ce6ad0344ff83071666981fca6d133f77e15bc28a07676c59dbfbc9af849e
MD5 bcd59d2fe9ac1f334e0504628da16f1b
BLAKE2b-256 1478e4fdcf08c91ae24671b3de0f85d773f469480e7c53598d1b945703c6ee73

See more details on using hashes here.

File details

Details for the file oxrpy-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: oxrpy-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 3.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for oxrpy-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae43743bca0e46dfd02c07017dfc21c5ac3bab1e231fff038dfd4c68c03c6938
MD5 27da651d5993f5378059d3ae09881aa1
BLAKE2b-256 bed2d83656ea79eb046c83f2bccbe1a27cdeedc8b928fc7b6e09e016e7787b08

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