Skip to content

Openarl/PyPoE

 
 

Repository files navigation

PyPoE

Collection of Python Tools for Path of Exile.

More detailed docs: http://omegak2.net/poe/PyPoE/

The docs are occasionally updated until I get a build bot up - however docs can also be manually built with sphinx.

Please make sure to install Python 3.4 not 3.5 if you want to use the UI. Pyside (the UI library) currently does not support python 3.5

Build Status

Overview

Parts:

  • Library toolkit for programmers (PyPoE/poe)
  • UI based on QT for browsing the game files
  • CLI interface for extracting/exporting data (for the wiki, more TBD)

Resources

IRC Channel: freenode.net/#PyPoE

Imporant Notes

Alpha Stage:

  • Code structure and in particular the API may change at any time
  • incomplete in many areas (check files and TODOs)
  • and tests still have to be written for a lot of things.
  • many functions and classes are not yet fully documentated

Dev branch:

  • broken code may be committed occasionally to the dev branch

Quick Setup Guide

These instructions are for the current development version of PyPoE.

  • Install Python 3.4 & git
  • make sure Python 3.4 and python scripts folder is in your %PATH% on windows
  • checkout PyPoE with git
  • go into the PyPoE folder
  • Minimum install: pip install -e .
  • Full install: pip install -e .[full]

Usage

  • UI: pypoe_ui
  • CLI: pypoe_exporter (follow the instructions)
  • API: check the individual files in PyPoE/poe/ or the docs http://omegak2.net/poe/PyPoE/

Credits

Credits - Libraries

About

Collection of Python Tools for Path of Exile

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%