Metadata-Version: 2.1
Name: gppc
Version: 0.1.7
Summary: Check OSRS Grand Exchange prices from the command line. Includes module functionality to check item full price history.
Home-page: https://pypi.org/project/gppc/
Author: moxxos
Author-email: moxxos@proton.me
License: GNU AGPLv3
Project-URL: Source, https://github.com/moxxos/gppc
Keywords: OSRS,Grand Exchange,GrandExchange,GE,OSRS Grand Exchange,Runescape,Oldschool Runescape,Old School Runescape,OS Runescape
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: <=3.12,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: requests
Requires-Dist: climage
Requires-Dist: platformdirs
Requires-Dist: pandas
Provides-Extra: dev
Requires-Dist: autopep8 (>=1.7.0) ; extra == 'dev'
Requires-Dist: flake8 (>=5.0.4) ; extra == 'dev'
Requires-Dist: pylint (>=2.15.2) ; extra == 'dev'
Requires-Dist: sphinx (>=5.3.0) ; extra == 'dev'

# GPPC (Gold Piece Price Checker) 

Check OSRS Grand Exchange prices from the command line. 
Includes module functionality to check item full price history.

# Usage

### Installation

```bash
$ pip install gppc
```

```bash 
$ git clone https://github.com/moxxos/gppc.git
$ cd gppc
$ pip install .
```

### Get the price and recent 24h change of many different Grand Exchange items.

```bash
$ gppc 'gold bar' coal
$ gppc gold_bar coal
```
![Image](https://raw.githubusercontent.com/moxxos/gppc/main/gppc_example.jpg)

### Import as a module

```python
>>> import gppc
>>> gppc.search('coal')
```

## New Feature
### Create item instances to check item recent history.


```python
>>> from gppc import Item
>>> coal = Item('coal')
>>> coal.recent_history
           Price Average    Volume
Date           
2022-06-09   161     160  46780917
2022-06-10   164     160  13746833
2022-06-11   164     160  44698810
...          ...     ...       ...
2022-12-02   171     163  24461683
2022-12-03   174     163  43027137
2022-12-04   173     163  25469205
[179 rows x 3 columns]
```
### Save multiple item histories for future use.
```python
>>> coal.save_history()
SAVED ITEM: Coal, id: 453
179 NEW DATES CREATED
179 RECORDS UPDATED

>>> bond.save_history()
SAVED ITEM: Old school bond, id: 13190
179 RECORDS UPDATED
```
### Check item full history at a later date if past history is saved.
```python
>>> coal.full_history()
           Price Average    Volume
Date           
2022-06-09   161     160  46780917
2022-06-10   164     160  13746833
2022-06-11   164     160  44698810
...          ...     ...       ...
2023-12-02   171     163  24461683
2023-12-03   174     163  43027137
2023-12-04   173     163  25469205
[544 rows x 3 columns]
```

# 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
#
