# GPPC (Gold Piece Price Checker)
Check OSRS Grand Exchange prices from the command line. Includes module functionality to check full price history of an item.
Features caching capability to save item price histories for future use.
# Usage
### Installation
```bash
$ pip install gppc
```
### or
```bash
$ git clone https://github.com/moxxos/gppc.git
$ cd gppc
$ pip install .
```
### Get the price and recent 24h change of many different items on the OSRS Grand Exchange straight from the command line.
```bash
$ gppc 'gold bar' coal
$ gppc gold_bar coal
```
### Import as a module.
```python
>>> import gppc
>>> gppc.search('coal')
```
### Create item instances to check item price and volume history. 4 different intervals available.
```python
>>> from gppc import Item
>>> coal = Item('coal')
```
### Past 1 day history at 5-minute intervals.
```
>>> coal.history_1day
timestamp avgHighPrice avgLowPrice highPriceVolume lowPriceVolume
0 2023-09-20 04:15:00 276.0 264 18195 31276
1 2023-09-20 04:20:00 289.0 265 7124 82582
2 2023-09-20 04:25:00 278.0 262 18889 80672
.. ... ... ... ... ...
362 2023-09-21 11:20:00 256.0 244 26604 89559
363 2023-09-21 11:25:00 256.0 243 42930 194245
364 2023-09-21 11:30:00 256.0 244 22929 66926
[365 rows x 5 columns]
```
### Past 1 year history at 1-day intervals.
```
>>> coal.history_1year
timestamp avgHighPrice avgLowPrice highPriceVolume lowPriceVolume
0 2022-09-20 20:00:00 144 142 7290293 8857481
1 2022-09-21 20:00:00 144 143 5821183 8728784
2 2022-09-22 20:00:00 147 145 5148730 9724897
.. ... ... ... ... ...
362 2023-09-17 20:00:00 221 217 8200818 14460078
363 2023-09-18 20:00:00 243 236 8815340 20995587
364 2023-09-19 20:00:00 236 235 8746294 17259336
[365 rows x 5 columns]
```
### Two other intervals available for 2 week and 3 month histories.
```
>>> hist_2week = coal.history_2week
>>> hist_3month = coal.history_3month
```
### Save multiple item histories for future use depending on which histories you have accessed.
```
>>> coal_hist_1d = coal.history_1day
>>> coal_hist_2w = coal.history_2week
>>> coal_hist_3m = coal.history_3month
>>> coal_hist_1y = coal.history_1year
>>> coal.save_history()
1281 new records added for item: Coal
>>> bond_hist_1y = bond.history_1year
>>> bond.save_history()
365 new records added for item: Old school bond
```
### Check item full history if past history is saved.
```
>>> coal.full_history
timestamp avgHighPrice avgLowPrice highPriceVolume lowPriceVolume
0 2022-09-20 20:00:00 144.0 142 7290293 8857481
1 2022-09-21 20:00:00 144.0 143 5821183 8728784
2 2022-09-22 20:00:00 147.0 145 5148730 9724897
... ... ... ... ... ...
1278 2023-09-21 18:20:00 253.0 245 2090 47719
1279 2023-09-21 18:25:00 252.0 245 11647 70886
1280 2023-09-21 18:30:00 246.0 244 20901 49703
[1281 rows x 5 columns]
```
### Create catalogs to easily manipulate lists of items.
```python
>>> from gppc import Catalog
>>> ores = Catalog('copper ore', 'tin ore', 'iron ore', 'gold ore', 'silver ore', 'mithril ore', 'adamantite ore', 'runite ore')
>>> ores.sort()
>>> ores
['Adamantite ore', 'Copper ore', 'Gold ore', 'Iron ore', 'Mithril ore', 'Runite ore', 'Silver ore', 'Tin ore']
>>> ores.remove('Gold ore')
>>> ores
['Adamantite ore', 'Copper ore', 'Iron ore', 'Mithril ore', 'Runite ore', 'Silver ore', 'Tin ore']
```
### Save the history of all items in your catalog.
```
>>> ores.save_history('1day')
365 new records added for item: Adamantite ore
365 new records added for item: Copper ore
365 new records added for item: Iron ore
365 new records added for item: Mithril ore
365 new records added for item: Runite ore
365 new records added for item: Silver ore
365 new records added for item: Tin ore
```
### A catalog with no arguments creates a full list of all items in the Grand Exchange.
```python
>>> all_items = Catalog()
>>> len(all_items)
4005
```
# Updates
## [CHANGELOG](https://github.com/moxxos/gppc/blob/main/CHANGELOG.md)
# TODO
- [ ] Finish command line display
- [ ] Add tests and documentation
## [0.1.6.] - 2022-12-04
### New Item module
#
## [0.1.5.] - 2022-10-18
### Display output now works on Windows.
### Added image caching.
#
## [0.1.4] - 2022-10-07
### Removed pycache from repo.
### Added MANIFEST.in to process CHANGELOG.md during build process.
#
## [0.1.3] - 2022-10-07
### Fixed README and description for build and setup.
### PYPI description now renders correctly.
#
## [0.1.1] - 2022-10-06
### Now works. Also displays item images.
#
## [0.1.0] - 2022-09-12
### Configured pyproject.toml
#
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/gppc/",
"name": "gppc",
"maintainer": "",
"docs_url": null,
"requires_python": "<=3.12,>=3.8",
"maintainer_email": "",
"keywords": "OSRS,Grand Exchange,GrandExchange,GE,OSRS Grand Exchange,Runescape,Oldschool Runescape,Old School Runescape,OS Runescape",
"author": "moxxos",
"author_email": "moxxos@proton.me",
"download_url": "https://files.pythonhosted.org/packages/19/9e/285684b5de51d6a4189d7378fd45bf4bab31e3d8b8153489b1a16f836f82/gppc-0.1.9.tar.gz",
"platform": null,
"description": "# GPPC (Gold Piece Price Checker) \n\nCheck OSRS Grand Exchange prices from the command line. Includes module functionality to check full price history of an item.\nFeatures caching capability to save item price histories for future use.\n\n# Usage\n\n### Installation\n\n```bash\n$ pip install gppc\n```\n### or\n```bash \n$ git clone https://github.com/moxxos/gppc.git\n$ cd gppc\n$ pip install .\n```\n\n### Get the price and recent 24h change of many different items on the OSRS Grand Exchange straight from the command line.\n\n```bash\n$ gppc 'gold bar' coal\n$ gppc gold_bar coal\n```\n\n\n### Import as a module.\n\n```python\n>>> import gppc\n>>> gppc.search('coal')\n```\n\n\n### Create item instances to check item price and volume history. 4 different intervals available.\n\n\n```python\n>>> from gppc import Item\n>>> coal = Item('coal')\n```\n### Past 1 day history at 5-minute intervals.\n```\n>>> coal.history_1day\n timestamp avgHighPrice avgLowPrice highPriceVolume lowPriceVolume\n0 2023-09-20 04:15:00 276.0 264 18195 31276\n1 2023-09-20 04:20:00 289.0 265 7124 82582\n2 2023-09-20 04:25:00 278.0 262 18889 80672\n.. ... ... ... ... ...\n362 2023-09-21 11:20:00 256.0 244 26604 89559\n363 2023-09-21 11:25:00 256.0 243 42930 194245\n364 2023-09-21 11:30:00 256.0 244 22929 66926\n\n[365 rows x 5 columns]\n```\n### Past 1 year history at 1-day intervals.\n```\n>>> coal.history_1year\n timestamp avgHighPrice avgLowPrice highPriceVolume lowPriceVolume\n0 2022-09-20 20:00:00 144 142 7290293 8857481\n1 2022-09-21 20:00:00 144 143 5821183 8728784\n2 2022-09-22 20:00:00 147 145 5148730 9724897\n.. ... ... ... ... ...\n362 2023-09-17 20:00:00 221 217 8200818 14460078\n363 2023-09-18 20:00:00 243 236 8815340 20995587\n364 2023-09-19 20:00:00 236 235 8746294 17259336\n\n[365 rows x 5 columns]\n```\n### Two other intervals available for 2 week and 3 month histories.\n```\n>>> hist_2week = coal.history_2week\n>>> hist_3month = coal.history_3month\n```\n### Save multiple item histories for future use depending on which histories you have accessed.\n```\n>>> coal_hist_1d = coal.history_1day\n>>> coal_hist_2w = coal.history_2week\n>>> coal_hist_3m = coal.history_3month\n>>> coal_hist_1y = coal.history_1year\n>>> coal.save_history()\n1281 new records added for item: Coal\n\n>>> bond_hist_1y = bond.history_1year\n>>> bond.save_history()\n365 new records added for item: Old school bond\n```\n### Check item full history if past history is saved.\n```\n>>> coal.full_history\n timestamp avgHighPrice avgLowPrice highPriceVolume lowPriceVolume\n0 2022-09-20 20:00:00 144.0 142 7290293 8857481\n1 2022-09-21 20:00:00 144.0 143 5821183 8728784\n2 2022-09-22 20:00:00 147.0 145 5148730 9724897\n... ... ... ... ... ...\n1278 2023-09-21 18:20:00 253.0 245 2090 47719\n1279 2023-09-21 18:25:00 252.0 245 11647 70886\n1280 2023-09-21 18:30:00 246.0 244 20901 49703\n\n[1281 rows x 5 columns]\n```\n### Create catalogs to easily manipulate lists of items.\n```python\n>>> from gppc import Catalog\n>>> ores = Catalog('copper ore', 'tin ore', 'iron ore', 'gold ore', 'silver ore', 'mithril ore', 'adamantite ore', 'runite ore')\n>>> ores.sort()\n>>> ores\n['Adamantite ore', 'Copper ore', 'Gold ore', 'Iron ore', 'Mithril ore', 'Runite ore', 'Silver ore', 'Tin ore']\n>>> ores.remove('Gold ore')\n>>> ores\n['Adamantite ore', 'Copper ore', 'Iron ore', 'Mithril ore', 'Runite ore', 'Silver ore', 'Tin ore']\n```\n### Save the history of all items in your catalog.\n```\n>>> ores.save_history('1day')\n365 new records added for item: Adamantite ore\n365 new records added for item: Copper ore\n365 new records added for item: Iron ore\n365 new records added for item: Mithril ore\n365 new records added for item: Runite ore\n365 new records added for item: Silver ore\n365 new records added for item: Tin ore\n```\n### A catalog with no arguments creates a full list of all items in the Grand Exchange.\n```python\n>>> all_items = Catalog()\n>>> len(all_items)\n4005\n```\n\n# Updates\n\n## [CHANGELOG](https://github.com/moxxos/gppc/blob/main/CHANGELOG.md)\n\n# TODO\n- [ ] Finish command line display\n- [ ] Add tests and documentation\n## [0.1.6.] - 2022-12-04\n### New Item module\n#\n\n## [0.1.5.] - 2022-10-18\n### Display output now works on Windows.\n### Added image caching.\n#\n\n## [0.1.4] - 2022-10-07\n### Removed pycache from repo.\n### Added MANIFEST.in to process CHANGELOG.md during build process.\n#\n\n## [0.1.3] - 2022-10-07\n### Fixed README and description for build and setup.\n### PYPI description now renders correctly.\n#\n\n## [0.1.1] - 2022-10-06\n### Now works. Also displays item images.\n#\n\n## [0.1.0] - 2022-09-12\n### Configured pyproject.toml\n#\n",
"bugtrack_url": null,
"license": "GNU AGPLv3",
"summary": "Check OSRS Grand Exchange prices from the command line. Includes module functionality to check and save item price history.",
"version": "0.1.9",
"project_urls": {
"Homepage": "https://pypi.org/project/gppc/",
"Source": "https://github.com/moxxos/gppc"
},
"split_keywords": [
"osrs",
"grand exchange",
"grandexchange",
"ge",
"osrs grand exchange",
"runescape",
"oldschool runescape",
"old school runescape",
"os runescape"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e65ec87c94757c273caded4f91fcf75ca9efa0387a0322f4f0e8a671a5638f21",
"md5": "1ab85c2f57bb290b8f1b265db952a18c",
"sha256": "0e770d1c2daca37870642d90a5c685523007e7859c99f4f7e7cc19357cd7d5be"
},
"downloads": -1,
"filename": "gppc-0.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ab85c2f57bb290b8f1b265db952a18c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<=3.12,>=3.8",
"size": 25677,
"upload_time": "2023-10-04T18:36:33",
"upload_time_iso_8601": "2023-10-04T18:36:33.872153Z",
"url": "https://files.pythonhosted.org/packages/e6/5e/c87c94757c273caded4f91fcf75ca9efa0387a0322f4f0e8a671a5638f21/gppc-0.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "199e285684b5de51d6a4189d7378fd45bf4bab31e3d8b8153489b1a16f836f82",
"md5": "e5b953ebb022022c303287be000b7f2a",
"sha256": "79c9f1dc343baba98a13fc0ff5d5607ffe21c97d58920ae374c8d11a16f798fb"
},
"downloads": -1,
"filename": "gppc-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "e5b953ebb022022c303287be000b7f2a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<=3.12,>=3.8",
"size": 26278,
"upload_time": "2023-10-04T18:41:27",
"upload_time_iso_8601": "2023-10-04T18:41:27.531253Z",
"url": "https://files.pythonhosted.org/packages/19/9e/285684b5de51d6a4189d7378fd45bf4bab31e3d8b8153489b1a16f836f82/gppc-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-04 18:41:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "moxxos",
"github_project": "gppc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "gppc"
}
JSON
