tap-copper

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

This tap:

• Pulls raw data from the copper API.

• Extracts the following resources:

  • Account

  • ActivitiesSearch

  • Companies

  • ContactTypes

  • CustomFieldDefinitions

  • CustomerSources

  • LeadStatuses

  • Leads

  • LossReasons

  • Opportunities

  • People

  • PipelineStages

  • Pipelines

  • Projects

  • Tags

  • Tasks

  • Users

• Outputs the schema for each resource

• Incrementally pulls data based on the input state

Streams

account

Data Key = root

Primary keys: ['id']

Replication strategy: FULL_TABLE

activities_search

Primary keys: ['id']

Replication strategy: INCREMENTAL

companies

Primary keys: ['id']

Replication strategy: INCREMENTAL

contact_types

Data Key = root

Primary keys: ['id']

Replication strategy: FULL_TABLE

custom_field_definitions

Data Key = root

Primary keys: ['id']

Replication strategy: FULL_TABLE

customer_sources

Data Key = root

Primary keys: ['id']

Replication strategy: FULL_TABLE

lead_statuses

Data Key = root

Primary keys: ['id']

Replication strategy: FULL_TABLE

leads

Primary keys: ['id']

Replication strategy: INCREMENTAL

loss_reasons

Data Key = root

Primary keys: ['id']

Replication strategy: FULL_TABLE

opportunities

Primary keys: ['id']

Replication strategy: INCREMENTAL

people

Primary keys: ['id']

Replication strategy: INCREMENTAL

pipeline_stages

Data Key = root

Primary keys: ['id']

Replication strategy: FULL_TABLE

pipelines

Data Key = root

Primary keys: ['id']

Replication strategy: FULL_TABLE

projects

Primary keys: ['id']

Replication strategy: INCREMENTAL

tags

Data Key = root

Primary keys: ['name']

Replication strategy: FULL_TABLE

tasks

Primary keys: ['id']

Replication strategy: INCREMENTAL

users

Primary keys: ['id']

Replication strategy: FULL_TABLE

Note on pipeline_stages

The pipeline_stages stream appears in discovery but is marked as unsupported (inclusion=unsupported, selected-by-default=false).
It will not sync by default. If manually selected, the Copper API returns a 401 Unauthorized error.
This behavior is intentional and consistent with other official taps (e.g., tap-workday).

Authentication

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-copper
   > 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:

   • api_key - the api_key from your Copper account.
   • user_email - the email address associated with your Copper account.
   • start_date - The start date for data extraction in ISO 8601 format. e.g. "2023-01-01T00:00:00Z".

   {
       "api_key": "your_copper_api_key_here",
       "user_email": "[email protected]",
       "start_date": "2023-01-01T00:00:00Z"
   }

   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": "people",
       "bookmarks": {
           "companies": "2019-09-27T22:34:39Z",
           "projects": "2019-09-28T15:30:26Z",
           "tasks": "2019-09-28T18:23:53Z"
       }
   }

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

   tap-copper --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-copper --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-copper --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-copper --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 copper tap, the following utilities were run in accordance with Singer.io best practices: Pylint to improve code quality:

   > pylint tap_copper -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_copper --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 .
   

---

Copyright © 2019 Stitch