Skip to content

Commit

Permalink
docs: improves README examples
Browse files Browse the repository at this point in the history
  • Loading branch information
jmgilman committed May 24, 2024
1 parent 18c0112 commit 625246a
Showing 1 changed file with 27 additions and 15 deletions.
42 changes: 27 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,28 @@ Check our balance of beer and then buy some from the local market:

```python
>>> from pymerc.api.models.common import Item
>>> player.storehouse.items[Item.Beer].balance
>>> beer = player.storehouse.items[Item.Beer]
>>> beer.balance
41.5
>>> player.storehouse.items[Item.Beer].market_data
>>> beer.market_data
TownMarketItem(price=2.894, last_price=2.894, average_price=2.894, moving_average=2.868, highest_bid=2.894, lowest_ask=3.0, volume=95, volume_prev_12=1085, bid_volume_10=2, ask_volume_10=20)
>>> await player.storehouse.items[Item.Beer].fetch_market_details()
TownMarketItemDetails(id=47424441199, product=<Item.Beer: 'beer'>, asset=<Item.Beer: 'beer'>, currency='money', bids=[ItemOrder(volume=2, price=2.894)], asks=[ItemOrder(volume=20, price=3.0), ItemOrder(volume=1, price=3.425), ItemOrder(volume=3, price=3.475), ItemOrder(volume=1, price=3.526)], data=TownMarketItem(price=2.894, last_price=2.894, average_price=2.894, moving_average=2.868, highest_bid=2.894, lowest_ask=3.0, volume=95, volume_prev_12=1085, bid_volume_10=0, ask_volume_10=0))
>>> result = await player.storehouse.items[Item.Beer].buy(1, 3.0)
>>> details = await beer.fetch_market_details() # More fine-grained details
>>> details.asks
[ItemOrder(volume=20, price=3.0),
ItemOrder(volume=1, price=3.425),
ItemOrder(volume=3, price=3.475),
ItemOrder(volume=1, price=3.526)]
>>> result = await beer.buy(1, 3.0)
>>> result.settlements[0].volume
1
```

Adjust the price and volume of beer we are selling:

```python
>>> result.settlements[0].volume
1
>>> player.storehouse.items[Item.Beer].manager
>>> beer.manager
InventoryManager(buy_price=5.45, buy_volume=0, capacity=100, max_holding=None, sell_price=2.8, sell_volume=25)
>>> await player.storehouse.items[Item.Beer].patch_manager(sell_price=2.7, sell_volume=26)
>>> await beer.patch_manager(sell_price=2.7, sell_volume=26)
>>> player.storehouse.items[Item.Beer].manager
InventoryManager(buy_price=5.45, buy_volume=0, capacity=100, max_holding=None, sell_price=2.7, sell_volume=26)
```
Expand All @@ -73,7 +78,7 @@ True

List the items we are exporting here:

```
```python
>>> list(tr.exports.keys())
[<Item.Cloth: 'cloth'>,
<Item.DyedCloth: 'dyed cloth'>,
Expand All @@ -83,21 +88,28 @@ List the items we are exporting here:
Check how much cloth we exported last turn:

```python
>>> tr.exports[Item.Cloth].manager
InventoryManager(buy_price=None, buy_volume=0, capacity=None, max_holding=None, sell_price=5.0, sell_volume=37)
>>> tr.exports[Item.Cloth].manager.sell_volume
37
>>> tr.exports[Item.Cloth].volume_flowed
37
```

Looks like we are at max capacity for our export.
Bump our export volume and then buy some more cloth off the Aderhampton market:

```python
>>> await tr.exports[Item.Cloth].patch_manager(sell_volume=38)
>>> await tr.exports[Item.Cloth].fetch_market_details()
TownMarketItemDetails(id=146229288343, product=<Item.Cloth: 'cloth'>, asset=<Item.Cloth: 'cloth'>, currency='money', bids=[ItemOrder(volume=1, price=7.736), ItemOrder(volume=1, price=7.341), ItemOrder(volume=1, price=6.601)], asks=[ItemOrder(volume=1, price=9.072), ItemOrder(volume=1, price=9.205), ItemOrder(volume=1, price=9.339), ItemOrder(volume=1, price=13.677), ItemOrder(volume=1, price=14.152), ItemOrder(volume=3, price=14.628), ItemOrder(volume=1, price=14.699), ItemOrder(volume=3, price=14.919), ItemOrder(volume=6, price=15.138), ItemOrder(volume=3, price=15.358), ItemOrder(volume=1, price=15.578)], data=TownMarketItem(price=7.736, last_price=7.736, average_price=7.736, moving_average=8.918, highest_bid=7.736, lowest_ask=9.072, volume=100, volume_prev_12=1048, bid_volume_10=0, ask_volume_10=0))
>>> details = await tr.exports[Item.Cloth].fetch_market_details()
>>> details.bids
[ItemOrder(volume=1, price=8.99),
ItemOrder(volume=3, price=8.856),
ItemOrder(volume=1, price=8.822),
ItemOrder(volume=1, price=8.478),
ItemOrder(volume=5, price=8.441),
ItemOrder(volume=1, price=5.414)]
>>> player.storehouse.items[Item.Cloth].balance
1477.096
>>> await tr.exports[Item.Cloth].sell(1, 7.736)
>>> await tr.exports[Item.Cloth].sell(1, 8.99)
>>> player.storehouse.items[Item.Cloth].balance
1476.096
```
Expand Down

0 comments on commit 625246a

Please sign in to comment.