An OldSchool RuneScape API wrapper for Python.
Project description
yew
yew
is an OldSchool RuneScape API wrapper for Python. It lets you invoke entities of OSRS as Python objects.
Installation
Install from PyPi:
pip install yew
You can also install the development version from the repository as:
pip install git+https://github.com/bharat-nair/yew.git@development
Usage
Fetch an item:
from yew.item import Item
rune_scimmy = Item(id="1333")
rune_scimmy.examine # "A vicious, curved sword."
rune_scimmy.highalch # 15360
Fetch the latest prices:
prices = rune_scimmy.prices(interval="latest")
prices.high_price # '15.1k'
str(prices.high_price_time) # '2024-04-04 12:12:12'
Fetch a player:
from yew.player import Player
lynx_titan = Player("Lynx Titan")
lynx_titan.cooking.level # 99
lynx_titan.cooking.xp # 200000000
Contributing
All contributions are welcome! If you would like to propose a new feature or raise a bug you have encountered, please create a new Github issue. Make sure to provide a concise title and a descriptive description, going over the aspects of your feature or bug.
If you would like to contribute to the development of yew
, all relevant PRs are welcome.
To get started:
- Fork this repository.
- Install dependencies by running:
Note that it might be beneficial to create a Python virtual environment to keep your local dependencies clean.pip install -r requirements.txt
- Raise a PR to the
development
branch, once you have made your changes and pushed them.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.