Metadata-Version: 2.1
Name: urmarketscraper
Version: 1.0.1
Summary: Collects market offers for Urban Rivals.
Home-page: https://github.com/brentspector/urmarketscraper
License: MIT
Author: Brent Spector
Author-email: brent.spector@yahoo.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: bs4 (>=0.0.1,<0.0.2)
Requires-Dist: requests (>=2.23.0,<3.0.0)
Project-URL: Repository, https://github.com/brentspector/urmarketscraper
Description-Content-Type: text/markdown

# Urban Rivals Market Scraper

## Collects market offers for Urban Rivals.

#### Install from https://pypi.org/project/urmarketscraper/

This is a screen scraper utility for [Urban Rivals](https://www.urban-rivals.com).

To use, call `market.get_market_offers`

The first parameter is the `requests.Session()` object which contains a logged-in
user. The second parameter is the list of `ids` for the characters in question.
The third parameter is an optional override for what what the base market address
is. Default is `https://www.urban-rivals.com/market/?`. Any url given here must end
with a `?` so that the URL encoding can complete correctly.

[Basic Usage Example](docs/market/basic-usage.rst)

[Full Documentation](https://urmarketscraper.readthedocs.io/en/latest/)

### Example
```python
>>> from urmarketscraper import market
>>> market.get_market_offers(session, ["1462", "1463"])
Returns:
    {"1462": {"_Offer__id": 1462, "_Offer__level_price_dict": {"1": "799", "4": "799"}}, "1463": {"_Offer__id": 1463, 
 "_Offer__level_price_dict": {"2": "27887"}}}
```
