Skip to content
This repository has been archived by the owner on Jan 9, 2021. It is now read-only.
/ ps2-analysis Public archive

Daybreak Games Planetside 2 Data Analysis (UNOFFICIAL)

License

Notifications You must be signed in to change notification settings

spascou/ps2-analysis

Folders and files

NameName
Last commit message
Last commit date
Jul 22, 2020
Sep 13, 2020
Nov 22, 2020
Aug 20, 2020
Jul 8, 2020
May 4, 2020
Jul 13, 2020
Aug 18, 2020
Nov 22, 2020
May 4, 2020

Repository files navigation

ps2-analysis [WORK IN PROGRESS]

ps2-analysis is a library written in Python >= 3.8 that fetches data from the Daybreak Planetside 2 Census API and eases advanced analysis.

It uses its sister project, the ps2-census client whose objective is simply to handle data retrieval from the Census API. Further parsing and exploitation is performed here in ps2-analysis.

Features:

  • Currently supports infantry and vehicle weapons data
  • Downloads datasets from the API and stores them locally as ndjson files
  • Parses data and generates class objects suitable for further processing

Installation

pip install ps2-analysis

Examples

Examples are available in the examples folder:

  • discover_infantry_weapons.py: updates the infantry weapons datafile and outputs all different (nested) key paths as well as associated set of values encountered within the whole dataset; example output in discover_infantry_weapons.json
  • discover_vehicle_weapons.py: updates the vehicle weapons datafile and outputs all different (nested) key paths as well as associated set of values encountered within the whole dataset; example output in discover_vehicle_weapons.json
  • generate_infantry_weapons.py: no output; simply an example of InfantryWeapon objects generation
  • generate_vehicle_weapons.py: no output; simply an example of VehicleWeapon objects generation

Development

Environment

In order to develop ps2-analysis:

  • Setup a virtual environment with python 3.8
  • Install poetry
  • Install dependencies with poetry install
  • Run tests with pytest
  • Update dependencies with poetry update

To run the examples in the examples folder:

  • Add your Census API service ID to the CENSUS_SERVICE_ID environment variable
  • Create a folder inside the examples folder of the cloned repository: datafiles
  • Run the scripts and check the outputs

About

Daybreak Games Planetside 2 Data Analysis (UNOFFICIAL)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages