baserow-client 0.2.0

Client for the baserow.io API.

baserow-client

A Python client for Baserow.io with simple ORM capabilities.

Note: This package is currently under development. Some APIs may break without prior notice.

Installation

$ pip install baserow-client

Getting started

BaserowClient

The Baserow client provides direct access to many of the Baserow API endpoints. It must be initialized with the URL to your Baserow instance as well as a JWT or Token. Without authentication, the client may still be used to generate a JWT from user credentials.

from baserow.client import BaserowClient

client = BaserowClient('https://baserow.io', jwt='...')
client = BaserowClient('https://baserow.io', token='...')

client = BaserowClient('https://baserow.io')
user, jwt = client.token_auth('username', 'password')

If you use the login() method instead of token_auth(), the JWT will be installed into the same client right away.

Operations that require a JWT

Meta operations such as listing available applications, tables, fields or creating/updating/deleting databases, etc. require a JWT.

Examples

for db in client.list_all_applications():
  print(db, [t.name for t in db.tables])

for table in client.list_database_tables(13):
  print(table)

for field in client.list_database_table_fields(45):
  print(field)

Create/Read/Update/Delete rows

These operations do not require a JWT and can be performed with a long-lived token instead, which can be created from the Baserow UI. The Baserow Python client currently supports reading data only.

Examples

is_john_smith = Column('field_281').equal('John Smith')
page = client.list_database_table_rows(45, filter=[is_john_smith])
print(page.results)

You can use the paginate_database_table_rows() convenience method to receive an iterator for all pages.

Object-relational mapper

The Baserow Python client comes with basic ORM capabilities.

Note: The ORM API is not Mypy compatible. Support could be added by implementing a Mypy plugin.

Define models

# myapp/models.py

from baserow.orm import Column, ForeignKey, Model

class Product(Model):
  name = Column('Name')
  price = Column('Price')

class Customer(Model):
  name = Column('Name')
  favorite_products = ForeignKey('Favorite Products', Product)

Generate a database mapping

Because the database schema cannot be introspected using a normal token, it is necessary to generate a mapping for the ORM using a JWT. The easiest way to do this is to use the Baserow ORM command-line interface.

$ python -m baserow.orm \
    'My web shop' myapp.models.Product:Produces myapp.models.Customer:Customers \
    --url https://baserow.io --user [e-mail] --write-to var/conf/mapping.json

You can specify --password '...' to avoid the password prompt, or directly pass a JWT with --jwt '...'.

Database connection

# myapp/__main__.py

from baserow.client import BaserowClient
from baserow.orm import Database, DatabaseMapping
from .models import Product, Customer

client = BaserowClient('https://baserow.io', token='...')
db = Database(client, DatabaseMapping.load('var/data/mapping.json'))

for customer in db.select(Customer).filter(customer.name.contains('Alice')):
  print(f'{customer.name} likes:')
  for product in customer.favorite_products:
    print(f'- {product.name}')

---

Copyright © 2021 Niklas Rosenstein