Skip to content

API for Path of Building's build sharing format for builds in Path of Exile.

License

Notifications You must be signed in to change notification settings

ppoelzl/PathOfBuildingAPI

Repository files navigation

Path of Building API (pobapi)

Maintenance

Read the Docs - Build Status

PyPI - Python Version

PyPI - Library Version

PyPI - Project Status

PyPI - Distribution Format

PyPI - License

Code style - black

Standard Readme - Compliant

API for Path of Building's build sharing format for builds in Path of Exile.

Table of Contents

Background

Path Of Building API provides a comprehensive toolbox for processing Path of Building pastebins.
It is aimed at community developers:
  • looking to add Path of Building functionality to their apps.
  • upgrading from existing solutions.

Benefits from using this library:

  • Focus on your app's core competences
  • Spend your free time on unique features
  • Backwards-compatibility as PoB's export format changes
  • Tested and secure codebase

Install

pip install pobapi

Dependencies

Usage

>>> import pobapi >>> url = "https://pastebin.com/bQRjfedq" >>> build = pobapi.from_url(url) >>> print(build.ascendancy_name) Elementalist >>> print(build.bandit) None >>> print(build.stats.life) 6911 >>> if build.active_skill.name in ["Blade Vortex", "Vaal Blade Vortex"]: ... if "Storm Brand" in build.skill_names: ... print(build.config.brand_attached) ... True >>> for item in build.items: ... if item.name == "Inpulsa's Broken Heart": ... print(item) ... break ... Rarity: Unique Name: Inpulsa's Broken Heart Base: Sadist Garb Quality: 20 Sockets: (('G', 'G', 'G', 'B', 'B', 'B'),) LevelReq: 68 ItemLvl: 71 +64 to maximum Life 26% increased Damage if you have Shocked an Enemy Recently 33% increased Effect of Shock Shocked Enemies you Kill Explode, dealing 5% of their Maximum Life as Lightning Damage which cannot Shock Unaffected by Shock

Features

  • Look up and process:
    • Character stats (DPS, life, etc.)
    • Skill trees
    • Skills, skill groups and links
    • Gear and item sets
    • Path of Building configuration settings
    • Build author's notes
  • Exposes all of Path of Building's relevant stats and attributes in a simple and pythonic way.
  • Automatically calculates mod values on theorycrafted items.
  • Low memory footprint through slots and dynamically generated attributes.

Feedback

Please open a GitHub issue in this repository for any feedback you may have.

Roadmap

  • Support corruptions
  • Support enchantments

API

Documentation available at Read the Docs.

Contributing

Setup repository using Git (recommended):

git clone https://github.com/ppoelzl/PathOfBuildingAPI.git

Install dev dependencies using Poetry (recommended):

poetry install
If you have any questions about contributing, please open a GitHub issue.
Pull requests are gladly accepted.
Check out the Developer Guide for more info.

Licence

MIT © Peter Pölzl

Releases

No releases published

Packages

No packages published

Languages