Singer tap for Jotform, built with the Meltano SDK for Singer Taps.

Navigation

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics

Unverified details

These details have not been verified by PyPI
Meta
Classifiers
Report project as malware

Project description

tap-jotform

Singer Tap for Jotform. Built with the Meltano Singer SDK.

Capabilities

  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening

Settings

Setting Required Default Description
api_key True None Authentication key. See https://api.jotform.com/docs/#authentication
api_url False https://api.jotform.com API Base URL
user_agent False tap-jotform/0.0.1 User-Agent header
start_date False None Start date for data collection
requests_cache False None Cache configuration for HTTP requests
stream_maps False None Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config False None User-defined config values to be used within map expressions.
flattening_enabled False None 'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth False None The max depth to flatten schemas.

A full list of supported settings and capabilities is available by running: tap-jotform --about

Streams

Stream name API endpoint API docs Notes
forms /user/forms https://api.jotform.com/docs/#user-forms Replication for this stream is opt-in. See instructions below.
questions /form/{form_id}/questions https://api.jotform.com/docs/#form-id-questions
submissions /user/submissions https://api.jotform.com/docs/#user-submissions Replication for this stream is opt-in. See instructions below.
reports /user/reports https://api.jotform.com/docs/#user-reports
user_history /user/history https://api.jotform.com/docs/#user-history
folders (deprecated) /user/folders https://api.jotform.com/docs/#user-folders
labels /user/labels https://api.jotform.com/docs/#get-user-labels

Configuring incremental replication

By default, the forms and submissions stream are synced with FULL_TABLE replication. Incremental replication can be enabled by setting the replication metadata in the stream's entry in the catalog file:

  • replication_method: set toINCREMENTAL
  • replication_key set to created_at or updated_at. The former will omit updated submissions, while the latter will omit new submissions.

For example, to enable incremental replication for the submissions stream:

{
  "streams": [
    {
      "tap_stream_id": "submissions",
      "stream": "submissions",
      "replication_method": "INCREMENTAL",
      "replication_key": "updated_at",
    }
  ]
}

Source Authentication and Authorization

To generate an API key, follow the instructions in https://api.jotform.com/docs/#gettingstarted.

Usage

You can easily run tap-jotform by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-jotform --version
tap-jotform --help
tap-jotform --config CONFIG --discover > ./catalog.json

Developer Resources

Initialize your Development Environment

curl -LsSf https://astral.sh/uv/install.sh | sh  # or see https://docs.astral.sh/uv/getting-started/installation/
uv sync

Create and Run Tests

Create tests within the tap_jotform/tests subfolder and then run:

uv run pytest

You can also test the tap-jotform CLI interface directly using uv run:

uv run tap-jotform --help

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Use Meltano to run an EL pipeline:

# Test invocation:
uvx meltano invoke tap-jotform --version

# OR run a test `elt` pipeline:
uvx meltano run tap-jotform target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.

Project details

Verified details

These details have been verified by PyPI
Project links
Owner
GitHub Statistics

Unverified details

These details have not been verified by PyPI
Meta
Classifiers

Release history Release notifications | RSS feed

This version

0.7.4

0.7.3

0.7.2

0.7.1

0.7.0

0.6.3

0.6.2

0.6.1

0.6.0

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.1

0.4.0

0.3.0

0.2.1

0.2.0

0.1.0

0.0.6

0.0.6b1 pre-release

0.0.5

0.0.5b1 pre-release

0.0.4

0.0.4a3 pre-release

0.0.4a2 pre-release

0.0.4a1 pre-release

0.0.3

0.0.2

0.0.1

0.0.1a4 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tap_jotform-0.7.4.tar.gz (60.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tap_jotform-0.7.4-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file tap_jotform-0.7.4.tar.gz.

File metadata

  • Download URL: tap_jotform-0.7.4.tar.gz
  • Upload date:
  • Size: 60.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tap_jotform-0.7.4.tar.gz
Algorithm Hash digest
SHA256 c8bf7bb652c7f0ae39d0850d2c5a800d732902fddf92057da63e1506807b96fe
MD5 e40bf5bbb9289f280c040f83a8f64a55
BLAKE2b-256 6c14a7439bae2c489ebd957e5c3d9e1cd98980ed63dd1e6fd79dbc13b401e28f

See more details on using hashes here.

Provenance

The following attestation bundles were made for tap_jotform-0.7.4.tar.gz:

Publisher: dynamic-publish.yaml on reservoir-data/tap-jotform

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tap_jotform-0.7.4-py3-none-any.whl.

File metadata

  • Download URL: tap_jotform-0.7.4-py3-none-any.whl
  • Upload date:
  • Size: 12.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tap_jotform-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 268ee126c0b088117ac1075e683f9061cde6016e3a658fd7fcbfc00fb4b1380e
MD5 edf7a7e1305c2047128ed291474db1a4
BLAKE2b-256 10ac459d7daba6d7de60f9060d838dd7a7d73ddaf207e173045445aa7f53ae3b

See more details on using hashes here.

Provenance

The following attestation bundles were made for tap_jotform-0.7.4-py3-none-any.whl:

Publisher: dynamic-publish.yaml on reservoir-data/tap-jotform

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page