Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/datawookie/trundlerpy
https://github.com/datawookie/trundlerpy
hacktoberfest
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/datawookie/trundlerpy
- Owner: datawookie
- Created: 2020-08-26T02:31:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-21T11:46:50.000Z (almost 3 years ago)
- Last Synced: 2024-10-11T18:29:16.894Z (4 months ago)
- Topics: hacktoberfest
- Language: Jupyter Notebook
- Homepage:
- Size: 59.6 KB
- Stars: 2
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# trundlerpy
[](https://trundlerpy.readthedocs.io/en/latest/?badge=latest)
[](https://travis-ci.com/github/datawookie/trundlerpy)
[](https://codecov.io/gh/datawookie/trundlerpy)
[](https://www.codacy.com/manual/datawookie/trundlerpy?utm_source=github.com&utm_medium=referral&utm_content=datawookie/trundlerpy&utm_campaign=Badge_Grade)
This is a Python package for the Trundler API.
## Installation
### Install from PyPI
Install from PyPI.
```bash
pip3 install trundlerpy
```
### Install from GitHub
Install from GitHub.
```bash
pip3 install git+https://github.com/datawookie/trundlerpy
```
## Testing
To run the test suite:
1. Set the `TRUNDLER_KEY` environment variable.
2. Launch the tests with
```bash
pytest
```
## Documentation
To build the documentation:
```bash
make -C docs/ html
```
## Set the API Key
To access the full API you’ll need to first specify an API key.
To obtain a key, please [get in touch](https://www.trundler.dev/).
Storing your keys received from APIs and other sensitive information in a
secure file or as an environment variable is considered best practice to avoid
any potential malicious activity.
```python
import os
key = os.getenv('TRUNDLER_KEY')
```
## Usage
```python
from trundlerpy import Trundler
tr = Trundler(key = key)
```
### Retailers
Use `retailer()` to get a list of retailers.
```python
tr.retailer()
```
You can access the details for a specific retailer.
```python
tr.retailer(45)
```
### Products
Get a list of products for a specific retailer.
```python
tr.retailer_products(5)
```
Products can be filtered by name, brand or SKU.
```python
tr.retailer_products(5, product = "coffee", brand = "nespresso")
```
```python
tr.retailer_products(5, sku="7630047615160")
```
A similar search can be applied across all retailers.
```python
tr.products(product = "coffee")
```
```python
tr.products(sku="7630047615160")
```
Get information on a specific product, filtering it by ID.
```python
tr.product(530290)
```
Get price history data for a specific product.
```python
tr.product_prices(530290)
```
## Documentation
[TrundlerPy Documentation](https://trundlerpy.readthedocs.io/)