{"repo":"leonhard-s/auraxium","free":true,"listed":false,"github":"https://github.com/leonhard-s/auraxium","clone":"git clone https://github.com/leonhard-s/auraxium.git","description":"A high-level Python wrapper for the PlanetSide 2 API.","language":"Python","stars":29,"topics":["api-wrapper","planetside2","python","census","api","event-stream","ess","ps2"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Auraxium Auraxium is an object-oriented, pure-Python wrapper for the PlanetSide 2 API. It provides a simple object model that can be used by players and outfits without requiring deep knowledge of the API and its idiosyncrasies. - Clean, Pythonic API - Asynchronous endpoints to keep apps responsive during high API load - Low-level interface for more optimised, custom queries - Support for the real-time event streaming service (ESS) - User-configurable caching system - Fully type annotated The documentation for this project is hosted at Read the Docs. Table of Contents - Overview - Getting Started - Boilerplate Code - Usage - Retrieving Data - Event Streaming - Technical Details - Object Hierarchy - Caching - Network Connections - Object Model Alternatives - Contributing Overview The Census API used by PlanetSide 2 is powerful, but its design also carries a steep learning curve that makes a lot of basic API interactions rather tedious. Auraxium streamlines this by hiding the game-agnostic queries behind an object model specific to PlanetSide 2. Whenever data is accessed that is not currently loaded, the library dynamically generates and performs the necessary queries in the background before resuming execution. All queries that may incur network traffic and latency are asynchronous, which keeps multi-user applications - such as Discord bots - responsive. Getting Started All API interactions are performed through the auraxium.Client object. It is the main endpoint used to inter","default_branch":null,"files":null,"tree":[],"storefront":"/r/leonhard-s","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/leonhard-s/auraxium/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}