https://github.com/douglaslassance/airstorm
A ORM-like Python client for Airtable.
https://github.com/douglaslassance/airstorm
airtable orm python
Last synced: 6 months ago
JSON representation
A ORM-like Python client for Airtable.
- Host: GitHub
- URL: https://github.com/douglaslassance/airstorm
- Owner: douglaslassance
- License: mit
- Created: 2020-10-02T03:31:24.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2022-03-20T22:05:52.000Z (over 4 years ago)
- Last Synced: 2025-12-22T01:59:36.888Z (7 months ago)
- Topics: airtable, orm, python
- Language: Python
- Homepage:
- Size: 52.7 KB
- Stars: 9
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# airstorm
[](https://badge.fury.io/py/airstorm)
[](https://airstorm.readthedocs.io/en/latest)
[](https://codecov.io/gh/douglaslassance/airstorm)
Airstorm is a dynamic Python ORM for [Airtable](https://airtable.com). It allows you to easily interact with any base using Python with minimal setup.
## Main Features
- Object-oriented interface.
- Dynamic generation of data models from schema.
- Automatic foreign-key resolution.
- Caching layer to avoid abusing the Airtable API.
## Installation
```bash
pip install airstorm
```
## Usage
```python
from airstorm.base import Base
jamba_juice = Base('your_base_id', 'your_api_key', {'your': 'schema'})
smoothy = jamba_juice.Smoothie('some_smoothie_id') # Get your table record.
for fruit in smoothy.fruits: # Get linked record in a breeze.
print(fruit.name) # Access any field data.
print(smoothy.fruits.names) # Access to mutliple record field data at once.
```
## Getting the Schema
Unfortunatly currently this part of the process is not ideal.
Because Airtable does not provide access to the schema via their API, you'll have to "download" the schema manually via a web browser of choice.
The following [gist](https://gist.github.com/douglaslassance/0ba26f2cf2aa9bb21a521ba07d751244) is a script that you can run on a Chrome console from the Airtable base [API page](https://airtable.com/api) to get back the JSON schema that airtstorm is expecting to be fed with.
## Roadmap
- Field validation where possible.
- Push changes. Currently we are read-only.
- Downlading schema automatically using pyppeteer.
- Pythonic formulas.
## Development
This projects requires the following:
- [Python >=3.7.9](https://www.python.org/downloads/release/python-379/)
- [virtualenwrapper](https://pypi.org/project/virtualenvwrapper/) (macOS/Linux)
- [virtualenwrapper-win](https://pypi.org/project/virtualenvwrapper-win/) (Windows)
Make sure your `WORKON_HOME` environment variable is set on Windows, and create a `airstorm` virtual environment with `mkvirtualenv`.
Build systems for installing requirements and running tests are on board of the SublimeText project.