tap-airtable


Nametap-airtable JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
Summarytap-airtable is a Singer tap for Airtable, built with the Meltano SDK for Singer Taps.
upload_time2024-05-19 20:47:55
maintainerNone
docs_urlNone
authorTomas Votava
requires_python<3.12,>=3.9
licenseApache 2.0
keywords elt airtable
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # tap-airtable

`tap-airtable` is a Singer tap for Airtable usable with Meltano.

Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.

## Installation

### Standalone

You can install `tap-airtable` using `pipx` to install it globally on your system:

```bash
pipx install tap-airtable
```

### With Meltano

If you're using this tap with Meltano, you can install it as an extractor.
The tap is not yet available in the Meltano Hub, so you will need to install it from the source.

```bash
meltano add extractor tap-airtable --from-ref https://raw.githubusercontent.com/tomasvotava/tap-airtable/master/tap-airtable.yml
```

## Configuration

### Accepted Config Options

| Property | Required | Description |
|:---|:----|:---|
| `token` | Yes | Airtable API token |
| `base_ids` | No | List of base IDs to extract data from (if not given, all bases are extracted) |
| `table_mapping` | No | Mapping of Airtable table ids to target table names (if not given table names from Airtable are used) |

If `table_mapping` is not provided, the tap will use the table names from Airtable as target table names.
This may not be ideal if the table names are not human-readable or if they contain special characters.

### Standalone Configuration

```json
{
    "token": "<your airtable token>",
    "base_ids": ["<base_id_1>", "<base_id_2>"],
    "table_mapping": {
        "<table_id_1>": "target_table_name_1",
        "<table_id_2>": "target_table_name_2"
    }
}
```

Run the tap with:

```bash
tap-airtable --config config.json
```

### Meltano Configuration

Run `meltano config tap-airtable set --interactive` to set the configuration interactively.


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tap-airtable",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.12,>=3.9",
    "maintainer_email": null,
    "keywords": "ELT, Airtable",
    "author": "Tomas Votava",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/64/58/5884d1fc965015e340c74cc1822044eb75f6eaad7dc3bca2baad8ee5799a/tap_airtable-0.1.0.tar.gz",
    "platform": null,
    "description": "# tap-airtable\n\n`tap-airtable` is a Singer tap for Airtable usable with Meltano.\n\nBuilt with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.\n\n## Installation\n\n### Standalone\n\nYou can install `tap-airtable` using `pipx` to install it globally on your system:\n\n```bash\npipx install tap-airtable\n```\n\n### With Meltano\n\nIf you're using this tap with Meltano, you can install it as an extractor.\nThe tap is not yet available in the Meltano Hub, so you will need to install it from the source.\n\n```bash\nmeltano add extractor tap-airtable --from-ref https://raw.githubusercontent.com/tomasvotava/tap-airtable/master/tap-airtable.yml\n```\n\n## Configuration\n\n### Accepted Config Options\n\n| Property | Required | Description |\n|:---|:----|:---|\n| `token` | Yes | Airtable API token |\n| `base_ids` | No | List of base IDs to extract data from (if not given, all bases are extracted) |\n| `table_mapping` | No | Mapping of Airtable table ids to target table names (if not given table names from Airtable are used) |\n\nIf `table_mapping` is not provided, the tap will use the table names from Airtable as target table names.\nThis may not be ideal if the table names are not human-readable or if they contain special characters.\n\n### Standalone Configuration\n\n```json\n{\n    \"token\": \"<your airtable token>\",\n    \"base_ids\": [\"<base_id_1>\", \"<base_id_2>\"],\n    \"table_mapping\": {\n        \"<table_id_1>\": \"target_table_name_1\",\n        \"<table_id_2>\": \"target_table_name_2\"\n    }\n}\n```\n\nRun the tap with:\n\n```bash\ntap-airtable --config config.json\n```\n\n### Meltano Configuration\n\nRun `meltano config tap-airtable set --interactive` to set the configuration interactively.\n\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "tap-airtable is a Singer tap for Airtable, built with the Meltano SDK for Singer Taps.",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "elt",
        " airtable"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3b744baa15ca398fae1b48f6efbb6a00d3edacc1d9e4492d13710e6d153551ef",
                "md5": "62d243253e79a0a6acca85ea8f08d768",
                "sha256": "b3d0bddc5b2286289c55820c013ed6875b78d7e2c12166f872dd49d5faebbfc8"
            },
            "downloads": -1,
            "filename": "tap_airtable-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "62d243253e79a0a6acca85ea8f08d768",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.12,>=3.9",
            "size": 7589,
            "upload_time": "2024-05-19T20:47:54",
            "upload_time_iso_8601": "2024-05-19T20:47:54.013317Z",
            "url": "https://files.pythonhosted.org/packages/3b/74/4baa15ca398fae1b48f6efbb6a00d3edacc1d9e4492d13710e6d153551ef/tap_airtable-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "64585884d1fc965015e340c74cc1822044eb75f6eaad7dc3bca2baad8ee5799a",
                "md5": "f0b4c0c8b6215ad32bf4d70de43434cf",
                "sha256": "1f1e9ee610e0151e7eabe5ed35ce23a9bbaff56d0731fa386a2d046da815c4f3"
            },
            "downloads": -1,
            "filename": "tap_airtable-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f0b4c0c8b6215ad32bf4d70de43434cf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.12,>=3.9",
            "size": 5685,
            "upload_time": "2024-05-19T20:47:55",
            "upload_time_iso_8601": "2024-05-19T20:47:55.447222Z",
            "url": "https://files.pythonhosted.org/packages/64/58/5884d1fc965015e340c74cc1822044eb75f6eaad7dc3bca2baad8ee5799a/tap_airtable-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-19 20:47:55",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "tap-airtable"
}
        
Elapsed time: 1.14882s