Firetable

A CLI tool and Python library for Airtable

Introduction

Airtable is the best, but sometimes (nay, oftentimes) a web interface is not the best for a workflow. Airtable provides a handy and comprehensive API for downloading and uploading JSON data. Firetable is meant to bridge Airtable and the command line with:

1. a git-esque command line tool that supports standard UNIX pipes’ and
2. a Python library for using the API directly.

It’s called Firetable to preserve the namespace rights in case the Airtable folks want to hand down a blessed airtable.py package someday, and because I hope to eventually expand this package beyond the simple API stuff into integration with pandas, reportlab, etc.

Things that are Working Right Now

1. Download a complete table
2. Download a table view
3. Download a table restricted to specified fields

Up Next

1. Add support for sort and filterByFormula parameters.
2. Add support for POST requests.
3. Editing
   1. Download data and convert to YAML or Markdown.
   2. Open temp file in default text editor.
   3. Convert back to JSON and upload data.

Index

Table of Contents

• Firetable Commands
• endpoints
  • Creating a Table Endpoint
  • Creating a Record Endpoint
  • Sugar
• controller
• CLI
  • CLI
• Airtable API Reference
  • GET Record
  • GET Table
  • Post
  • Patch
  • Delete
• firetable
  • firetable package
  • Firetable Commands
  • controller
  • endpoints
  • tests
  • CLI

Indices and tables

• Index
• Module Index
• Search Page

Firetable

A CLI tool and Python library for Airtable

Introduction

Airtable is the best, but sometimes (nay, oftentimes) a web interface is not the best for a workflow. Airtable provides a handy and comprehensive API for downloading and uploading JSON data. Firetable is meant to bridge Airtable and the command line with:

1. a git-esque command line tool that supports standard UNIX pipes’ and
2. a Python library for using the API directly.

It’s called Firetable to preserve the namespace rights in case the Airtable folks want to hand down a blessed airtable.py package someday, and because I hope to eventually expand this package beyond the simple API stuff into integration with pandas, reportlab, etc.

Things that are Working Right Now

1. Download a complete table
2. Download a table view
3. Download a table restricted to specified fields

Up Next

1. Add support for sort and filterByFormula parameters.
2. Add support for POST requests.
3. Editing
   1. Download data and convert to YAML or Markdown.
   2. Open temp file in default text editor.
   3. Convert back to JSON and upload data.

Installation

Install firetable by running:

pip install firetable

Disclaimer

I am an amateur. Pull requests welcome and use at your own risk!

Contribute

• Issue Tracker: github.com/davidseibert/firetable/issues
• Source Code: github.com/davidseibert/firetable

License

The project is licensed under the MIT license.