Metadata-Version: 2.1
Name: airtable-cacher
Version: 1.2.3
Summary: Utility for caching api responses from the airtable-python-wrapper based on airtable-caching by rmountjoy
Home-page: https://github.com/bawpcwpn/AirtableCacher
Author: thuxley
Author-email: thomas.huxley90@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: airtable-python-wrapper

# Airtable Cacher

This plugin is fork of the work done by Ron Mountjoy on `Airtable Caching`
https://github.com/rmountjoy92/AirtableCaching

# Caching
First you must setup a recurring script that will cache the table.

```
from airtable_cacher import Base

airtable = Base(<AIRTABLE_BASE_ID>, <AIRTABLE_API_KEY>)

"""
Main Function
"""

airtable.cache_table(<AIRTABLE_PRODUCTS_TABLE>)

```

You can optionally supply a third argument to `Base()` for setting the json folder like so:

```
from airtable_cacher import Base

airtable = Base(<AIRTABLE_BASE_ID>, <AIRTABLE_API_KEY>, "my_json_folder")
```

## Caching images

If you'd like to cache images, you can do so by supplying an optional fourth argument

# Accessing cached data

```
from airtable_cacher import Table

products_table = Table(<AIRTABLE_BASE_ID>,<AIRTABLE_PRODUCTS_TABLE>)
```

If you have supplied a custom JSON folder path in the caching, you supply that as an optional third argument in
 `Table()`

```
from airtable_cacher import Table

products_table = Table(<AIRTABLE_BASE_ID>,<AIRTABLE_PRODUCTS_TABLE>, "my_json_folder")
```

To get all records then use

```
records = products_table.all()
```

