Skip to main content

Path of Building API

Pre-release Software Warning

This library is currently in pre-release status and may change in the near future.
Meanwhile I am looking forward to community feedback to accommodate most use cases.
Pull requests are gladly accepted and much appreciated!

Introduction

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

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.

Requirements

Setup Instructions

pip install pobapi

Setup Instructions For Developers

Setup virtual environment:

pip install virtualenv
cd my_project_folder
virtualenv venv

To activate on Microsoft Windows:

\venv\Scripts\activate

To activate on GNU/Linux:

source venv/bin/activate

Setup repository:

git clone https://github.com/ppoelzl/PathOfBuildingAPI.git
pip install -r requirements.txt

Basic 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

Documentation

Available at Read the Docs.

Feedback

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

Contribution

Pull requests are gladly accepted. Check out the Developer Guide.

To-Do

  • Support corruptions

  • Support enchantments

License

MIT

Release files for pobapi 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pobapi 0.6.0
File Size Uploaded
pobapi-0.6.0.tar.gz 547.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pobapi 0.6.0
File Interpreter ABI Platform
pobapi-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 573.2 kB

Release files / pobapi-0.6.0.tar.gz

Download URL pobapi-0.6.0.tar.gz
Size 547.0 kB
Tags Source
SHA-256 checksum
How to use checksums
fea21f5bd0435b966def18a9d44a35f720a2225b6d12e6088c1cb36f171d9e2f
BLAKE2b-256 checksum
How to use checksums
d22c8bb15f8daa6a2edadd7f49875792b6eeadb3ccab48b679f31db366917a9c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.1

Release files / pobapi-0.6.0-py3-none-any.whl

Download URL pobapi-0.6.0-py3-none-any.whl
Size 26.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fb86a70bda5599343cfdbe3775ebc425062ab8656d571b1a022f51522aa4095a
BLAKE2b-256 checksum
How to use checksums
9f68f9ab4a1e0446f819eb85492854565264e9321eb656fad43aa01550a3550a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.1

Release history Release notifications | RSS feed

This release

0.6.0 This release

2 release files

0.5.0

2 release files

0.2.4

1 release file

0.2.3

1 release file

0.2.0

1 release file

0.1.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page