Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add new variant of tap-getpocket #1001

Merged
merged 1 commit into from
Nov 3, 2022

Conversation

edgarrmondragon
Copy link
Collaborator

@netlify
Copy link

netlify bot commented Nov 3, 2022

Deploy Preview for meltano-hub ready!

Name Link
🔨 Latest commit 101e08d
🔍 Latest deploy log https://app.netlify.com/sites/meltano-hub/deploys/636416931aaef70008c99837
😎 Deploy Preview https://deploy-preview-1001--meltano-hub.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Nov 3, 2022

Testing plugin tap-getpocket (evelte variant):

Starting test job...
...
Job completed.

Auto-generated README.md

tap-getpocket

GetPocket tap class.

Built with the Meltano SDK for Singer Taps and Targets.

Capabilities

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

Settings

Setting Required Default Description
consumer_key True None The consumer key used in the authentication flow
access_token True None Access token to authenticate against the API service. Follow instructions in README to get
start_date False 2021-01-01T00:00:00Z The earliest record date to sync
favorite False None Whether to retrieve only favorited, unfavorited or all items
state False all Whether to retrieve only unread, archived or all items
detail_type False complete Whether to retrieve only basic information or all data about each item
tag False None Only return items with this tag_name. Use untagged to get only untagged items

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

Version info
tap-getpocket v1.1.0, Meltano SDK v0.3.18)
Usage info
melty-bot % tap-getpocket --help
Usage: tap-getpocket [OPTIONS]

  Execute the Singer tap.

Options:
  --state PATH              Use a bookmarks file for incremental replication.
  --catalog PATH            Use a Singer catalog file with the tap.
  --test                    Test connectivity by syncing a single record and
                            exiting.
  --discover                Run the tap in discovery mode.
  --config TEXT             Configuration file location or 'ENV' to use
                            environment variables.
  --format [json|markdown]  Specify output style for --about
  --about                   Display package metadata and settings.
  --version                 Display the package version.
  --help                    Show this message and exit.
Detected capabilities
  • ✅ 'discover'
  • ✅ 'catalog'
  • ✅ 'state'
  • ✅ 'about'
JSON Metadata
{
  "name": "tap-getpocket",
  "description": "GetPocket tap class.",
  "version": "1.1.0",
  "sdk_version": "0.3.18",
  "capabilities": [
    "catalog",
    "state",
    "discover",
    "about",
    "stream-maps"
  ],
  "settings": {
    "type": "object",
    "properties": {
      "consumer_key": {
        "type": [
          "string"
        ],
        "description": "The consumer key used in the authentication flow"
      },
      "access_token": {
        "type": [
          "string"
        ],
        "description": "Access token to authenticate against the API service. Follow instructions in README to get"
      },
      "start_date": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time",
        "default": "2021-01-01T00:00:00Z",
        "description": "The earliest record date to sync"
      },
      "favorite": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Whether to retrieve only favorited, unfavorited or all items"
      },
      "state": {
        "type": [
          "string",
          "null"
        ],
        "default": "all",
        "description": "Whether to retrieve only unread, archived or all items"
      },
      "detail_type": {
        "type": [
          "string",
          "null"
        ],
        "default": "complete",
        "description": "Whether to retrieve only basic information or all data about each item"
      },
      "tag": {
        "type": [
          "string",
          "null"
        ],
        "description": "Only return items with this tag_name. Use _untagged_ to get only untagged items"
      }
    },
    "required": [
      "consumer_key",
      "access_token"
    ]
  }
}
Discovered streams
  • list

@github-actions
Copy link

github-actions bot commented Nov 3, 2022

Testing plugin tap-getpocket (edgarrmondragon variant):

Starting test job...
...
Job completed.

Auto-generated README.md

tap-getpocket

Pocket tap class.

Built with the Meltano Singer SDK.

Capabilities

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

Settings

Setting Required Default Description
consumer_key True None Pocket application key
access_token True None Pocket user access token
start_date False None The earliest record datetime to sync as a UNIX timestamp
favorite False None Set to true to sync only favorite items, false to sync only non-favorite items, or omit to sync all items
content_type False None The content type of items to sync. By default, all content types are synced.
state True all Type of item state to sync. By default, all states are synced.
tag False None The tag to sync. By default, all tags are synced. Use _untagged_ to sync untagged items.
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-getpocket --about

Version info
tap-getpocket v0.0.1, Meltano SDK v0.13.0
Usage info
melty-bot % tap-getpocket --help
Usage: tap-getpocket [OPTIONS]

  Execute the Singer tap.

Options:
  --state PATH              Use a bookmarks file for incremental replication.
  --catalog PATH            Use a Singer catalog file with the tap.
  --test TEXT               Use --test to sync a single record for each
                            stream. Use --test=schema to test schema output
                            without syncing records.
  --discover                Run the tap in discovery mode.
  --config TEXT             Configuration file location or 'ENV' to use
                            environment variables.
  --format [json|markdown]  Specify output style for --about
  --about                   Display package metadata and settings.
  --version                 Display the package version.
  --help                    Show this message and exit.
Detected capabilities
  • ✅ 'discover'
  • ✅ 'catalog'
  • ✅ 'state'
  • ✅ 'about'
JSON Metadata
{
  "name": "tap-getpocket",
  "description": "Pocket tap class.",
  "version": "0.0.1",
  "sdk_version": "0.13.0",
  "capabilities": [
    "catalog",
    "state",
    "discover",
    "about",
    "stream-maps",
    "schema-flattening"
  ],
  "settings": {
    "type": "object",
    "properties": {
      "consumer_key": {
        "type": [
          "string"
        ],
        "description": "Pocket application key"
      },
      "access_token": {
        "type": [
          "string"
        ],
        "description": "Pocket user access token"
      },
      "start_date": {
        "type": [
          "string",
          "null"
        ],
        "description": "The earliest record datetime to sync as a UNIX timestamp"
      },
      "favorite": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Set to `true` to sync only favorite items, `false` to sync only non-favorite items, or omit to sync all items"
      },
      "content_type": {
        "type": [
          "string",
          "null"
        ],
        "description": "The content type of items to sync. By default, all content types are synced.",
        "enum": [
          "article",
          "video",
          "image"
        ]
      },
      "state": {
        "type": [
          "string"
        ],
        "default": "all",
        "description": "Type of item state to sync. By default, all states are synced.",
        "enum": [
          "archive",
          "unread",
          "all"
        ]
      },
      "tag": {
        "type": [
          "string",
          "null"
        ],
        "description": "The tag to sync. By default, all tags are synced. Use `_untagged_` to sync untagged items."
      },
      "stream_maps": {
        "type": [
          "object",
          "null"
        ],
        "properties": {},
        "description": "Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html)."
      },
      "stream_map_config": {
        "type": [
          "object",
          "null"
        ],
        "properties": {},
        "description": "User-defined config values to be used within map expressions."
      },
      "flattening_enabled": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "'True' to enable schema flattening and automatically expand nested properties."
      },
      "flattening_max_depth": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The max depth to flatten schemas."
      }
    },
    "required": [
      "consumer_key",
      "access_token",
      "state"
    ]
  }
}
Discovered streams
  • items

@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@meltano meltano deleted a comment from github-actions bot Nov 3, 2022
@edgarrmondragon edgarrmondragon merged commit 5923e01 into main Nov 3, 2022
@edgarrmondragon edgarrmondragon deleted the feat/new-tap-getpocket-variant branch November 3, 2022 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants