Metadata-Version: 2.1
Name: airtable-export
Version: 0.3
Summary: Export Airtable data to files on disk
Home-page: https://github.com/simonw/airtable-export
Author: Simon Willison
License: Apache License, Version 2.0
Project-URL: Issues, https://github.com/simonw/airtable-export/issues
Project-URL: CI, https://github.com/simonw/airtable-export/actions
Project-URL: Changelog, https://github.com/simonw/airtable-export/releases
Description: # airtable-export
        
        [![PyPI](https://img.shields.io/pypi/v/airtable-export.svg)](https://pypi.org/project/airtable-export/)
        [![Changelog](https://img.shields.io/github/v/release/simonw/airtable-export?include_prereleases&label=changelog)](https://github.com/simonw/airtable-export/releases)
        [![Tests](https://github.com/simonw/airtable-export/workflows/Test/badge.svg)](https://github.com/simonw/airtable-export/actions?query=workflow%3ATest)
        [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/airtable-export/blob/master/LICENSE)
        
        Export Airtable data to files on disk
        
        ## Installation
        
        Install this tool using `pip`:
        
            $ pip install airtable-export
        
        ## Usage
        
        You will need to know the following information:
        
        - Your Airtable base ID - this is a string starting with `app...`
        - Your Airtable API key - this is a string starting with `key...`
        - The names of each of the tables that you wish to export
        
        You can export all of your data to a folder called `export/` by running the following:
        
            airtable-export export base_id table1 table2 --key=key
        
        This example would create two files: `export/table1.yml` and `export/table2.yml`.
        
        Rather than passing the API key using the `--key` option you can set it as an environment variable called `AIRTABLE_KEY`.
        
        ## Export options
        
        By default the tool exports your data as YAML.
        
        You can also export as JSON or as [newline delimited JSON](http://ndjson.org/) using the `--json` or `--ndjson` options:
        
            airtable-export export base_id table1 table2 --key=key --ndjson
        
        ## Development
        
        To contribute to this tool, first checkout the code. Then create a new virtual environment:
        
            cd airtable-export
            python -mvenv venv
            source venv/bin/activate
        
        Or if you are using `pipenv`:
        
            pipenv shell
        
        Now install the dependencies and tests:
        
            pip install -e '.[test]'
        
        To run the tests:
        
            pytest
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: test
