Path of Exile Wiki:PyPoE
PyPoE is a python 3 based collection of development tools to work with Path of Exile developed by User:OmegaK2.
It is currently in a development alpha, which means it is neither feature complete nor well-tested and subject to frequent changes.
Overview
Goals of the Project
- provide a mostly complete and stable python3 api to work with Path of Exile and it's files
- have a stable and useful UI binding to browse the files
- provide CLI tools for extracting files for convince
- provide utilities to publish the data on the Path of Exile wiki
Features
- Development Library
- Graphical User Interface (UI or GUI)
- Command Line Interface (CLI)
Installation
These installation instructions are currently aimed at development builds.
Prerequisites
Python 3.4
Windows:
- Navigate to https://www.python.org/downloads/ and download the latest version of python 3.4
- Install and follow the instructions on screen
- In particular make sure the Python executable as well as the scripts folder are located in the %PATH% variable
Linux:
- Ubuntu/Debian: apt-get install python3
Git
Windows:
- Navigate to https://git-scm.com/ and download the latest version of git
- Make sure git is added to the %PATH% variable on windows
Linux:
- Ubuntu/Debian: apt-get install pip
QT4 (UI only, Linux only)
See http://pyside.readthedocs.org/en/latest/building/linux.html for details.
Installing PyPoE
It is highly recommended to use the development build if no stable release is available, so updates from git apply to the install.
Linux:
- On many distributions, python and pip can link to either version 2 or version 3 depending on the system defaults, instead consider using
python3
instead ofpython
pip3
instead ofpip
- Open a command line (Windows: cmd.exe )
- Navigate to the folder you want to have PyPoE installed to/from
- Run
git clone https://github.com/OmegaK2/PyPoE/tree/dev/
- Go into the checkout folder where
setup.py
resides
Running pip
To use the development install (it makes the files editable), specify -e
.
By default, PyPoE only installs the dependencies for the core (PyPoE.poe). However, there are additional packages available:
Group | description |
---|---|
ui | GUI support |
cli | CLI support |
cli-wikibot | Support for the --wiki option in the wiki exporter |
dev | Development libraries (i.e. for tests & generating documentation) |
The base command for installing is:
pip install -e .
If you wish to add any extra packges, add them in a comma-separated list in brackets behind the dot:
pip install -e .[ui,cli,cli-wikibot,dev]
Structure
Folder | Description |
---|---|
/ | The root folder of the project |
/PyPoE/ | The root python folder |
/PyPoE/_data/ | Shared data used by the other files. For example, the specifications for the .dat files reside there. |
/PyPoE/poe | The core API to work with Path of Exile; this will be of primary interest to other developers that want to use the API. |
/PyPoE/shared | Core libraries and functions that are not specific to path of exile |
/PyPoE/cli | Libraries and functions for the command line interface of PyPoE |
/PyPoE/ui | Libraries and functions for the QT4 based user interface of PyPoE |
/scripts/ | Collection of scripts intended to be invoked from the command line. |
/tests/ | pytest based tests for the library and scripts |