Skip to content

DropTracker-io/wom.py

 
 

Repository files navigation

wom.py

Stable version License Python versions Maintainability Coverage

An asynchronous wrapper for the Wise Old Man API.

The library aims to make it easy to interact with the Wise Old Man API by providing service methods matching all available endpoints and model classes for data consistency.


ℹ️ This is the DropTracker fork of wom.py

A maintained fork of upstream wom.py 1.0.0 with one goal: new Old School RuneScape content never breaks the client. All credit for wom.py goes to @Jonxslays; this fork stays MIT-licensed.

  • Metric-tolerant decoding. Upstream decodes metric fields as a strict enum, so a metric WOM added that the pinned client didn't know (a new boss/skill) failed the entire response — one unknown boss in a snapshot broke get_details. Here, metric-bearing response fields decode as str, so unknown metrics — and any new fields WOM adds — pass through instead of raising. Metric is still a str-valued enum, so snapshot.bosses[Metric.Zulrah] and metric=Metric.X params work exactly as before.
  • Self-updating enum. A weekly GitHub Action diffs the enum against WOM's authoritative @wise-old-man/utils catalogue and commits any new metrics automatically — a human is pinged only if that job fails.

So you don't track WOM's releases by hand, and new game content can't take the client down. Guarantees + caveats: DROPTRACKER_FORK.md.

Install (floats with our updates):

pip install "wom.py @ git+https://github.com/DropTracker-io/wom.py@droptracker"

Pin a specific commit instead of @droptracker for a reproducible build.


Documentation

Getting started

If you're new to using wom.py, check out our getting started guide.

Problems

If you're experiencing a problem with the library, please open an issue here, after first confirming a similar issue was not already created.

What is Wise Old Man

Wise Old Man is an open source Oldschool Runescape player progress tracker.

If you're interested in learning more about the Wise Old Man project, consider checking out any of these links:

Some of the popular features include:

  • Experience tracking
  • Boss killcounts
  • Player achievements
  • Group competitions
  • Global leaderboards
  • A discord bot for interacting with the API

Contributing

wom.py is open to contributions. Check out the contributing guide to learn how.

License

wom.py is licensed under the MIT License.

About

An asynchronous wrapper for the Wise Old Man API.

Resources

License

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Python 99.7%
  • Shell 0.3%