tap-trello

This is a Singer tap that produces JSON-formatted data following the Singer spec.

This tap:

• Pulls raw data from the [Trello API].

• Extracts the following resources:

  • BoardMemberships

  • BoardCustomFields

  • BoardLabels

  • CardAttachments

  • CardCustomFieldItems

  • Members

  • Organizations

  • OrganizationActions

  • OrganizationMembers

  • OrganizationMemberships

• Outputs the schema for each resource

• Incrementally pulls data based on the input state

Streams

board_memberships

• Primary keys: ['id', 'boardId']
• Replication strategy: FULL_TABLE

board_custom_fields

• Primary keys: ['id', 'boardId']
• Replication strategy: FULL_TABLE

board_labels

• Primary keys: ['id', 'boardId']
• Replication strategy: FULL_TABLE

card_attachments

• Primary keys: ['id', 'card_id']
• Replication strategy: FULL_TABLE

card_custom_field_items

• Primary keys: ['id', 'card_id']
• Replication strategy: FULL_TABLE

members

• Primary keys: ['id']
• Replication strategy: FULL_TABLE

organizations

• Primary keys: ['id']
• Replication strategy: FULL_TABLE

organization_actions

• Primary keys: ['id', 'organization_id']
• Replication strategy: INCREMENTAL

organization_members

• Primary keys: ['id', 'organization_id']
• Replication strategy: FULL_TABLE

organization_memberships

• Primary keys: ['id', 'organization_id']
• Replication strategy: FULL_TABLE

Authentication

This tap uses Trello's API Key and Token authentication method.

Obtaining API Credentials

1. Get your API Key:

   • Log in to your Trello account
   • Visit https://trello.com/power-ups/admin
   • Your API Key will be displayed on the page

2. Generate an API Token:

   • On the same Power-Ups admin page, click on the "Token" link next to your API Key
   • Authorize the application to access your Trello account
   • Copy the generated token (it remains valid until revoked)

3. Add credentials to your config:

   • Add both api_key and api_token to your config.json file

For more information, see the Trello API Documentation.

Quick Start

1. Install

   Clone this repository, and then install using setup.py. We recommend using a virtualenv:

   > virtualenv -p python3 venv
   > source venv/bin/activate
   > python setup.py install
   OR
   > cd .../tap-trello
   > pip install -e .

2. Dependent libraries. The following dependent libraries were installed.

   > pip install singer-python
   > pip install target-stitch
   > pip install target-json
   

   • singer-tools
   • target-stitch

3. Create your tap's config.json file. The tap config file for this tap should include these entries:

   • start_date - the default value to use if no bookmark exists for an endpoint (rfc3339 date string)
   • user_agent (string, optional): Process and email for API logging purposes. Example: tap-trello <api_user_email@your_company.com>
   • request_timeout (integer, 300): Max time for which request should wait to get a response. Default request_timeout is 300 seconds.

   {
       "api_key": "your_api_key_here",
       "api_token": "your_api_token_here",
       "start_date": "2019-01-01T00:00:00Z",
       "user_agent": "tap-trello <api_user_email@your_company.com>",
       "request_timeout": 300
   }

   Optionally, also create a state.json file. currently_syncing is an optional attribute used for identifying the last object to be synced in case the job is interrupted mid-stream. The next run would begin where the last job left off.

   {
       "currently_syncing": "engage",
       "bookmarks": {
           "export": "2019-09-27T22:34:39.000000Z",
           "funnels": "2019-09-28T15:30:26.000000Z",
           "revenue": "2019-09-28T18:23:53Z"
       }
   }

4. Run the Tap in Discovery Mode This creates a catalog.json for selecting objects/fields to integrate:

   tap-trello --config config.json --discover > catalog.json

   See the Singer docs on discovery mode here.

5. Run the Tap in Sync Mode (with catalog) and write out to state file

   For Sync mode:

   > tap-trello --config tap_config.json --catalog catalog.json > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

   To load to json files to verify outputs:

   > tap-trello --config tap_config.json --catalog catalog.json | target-json > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

   To pseudo-load to Stitch Import API with dry run:

   > tap-trello --config tap_config.json --catalog catalog.json | target-stitch --config target_config.json --dry-run > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

6. Test the Tap While developing the trello tap, the following utilities were run in accordance with Singer.io best practices: Pylint to improve code quality:

   > pylint tap_trello -d missing-docstring -d logging-format-interpolation -d too-many-locals -d too-many-arguments

   Pylint test resulted in the following score:

   Your code has been rated at 9.67/10

   To check the tap and verify working:

   > tap_trello --config tap_config.json --catalog catalog.json | singer-check-tap > state.json
   > tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

   Unit Tests

   Unit tests may be run with the following.

   python -m pytest --verbose
   

   Note, you may need to install test dependencies.

   pip install -e .'[dev]'
   

---

Copyright © 2020–2025 Stitch