initial commit

.github/workflows/ci_workflow.yml

@@ -0,0 +1,58 @@
+### A CI workflow template that runs linting and python testing
+### TODO: Modify as needed or as desired.
+
+name: Test tap-klaviyo-v2
+
+on: [push]
+
+jobs:
+  linting:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # Only lint using the primary version used for dev
+        python-version: [3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        version: 1.1.8
+    - name: Install dependencies
+      run: |
+        poetry install
+    - name: Run lint command from tox.ini
+      run: |
+        poetry run tox -e lint
+
+  pytest:
+
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+    strategy:
+      matrix:
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        version: 1.1.11
+    - name: Install dependencies
+      run: |
+        poetry install
+    - name: Test with pytest
+      run: |
+        poetry run pytest --capture=no

.gitignore

@@ -0,0 +1,136 @@
+# Secrets and internal config files
+**/.secrets/*
+
+# Ignore meltano internal cache and sqlite systemdb
+
+.meltano/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

.secrets/.gitignore

@@ -0,0 +1,10 @@
+# IMPORTANT! This folder is hidden from git - if you need to store config files or other secrets,
+# make sure those are never staged for commit into your git repo. You can store them here or another
+# secure location.
+#
+# Note: This may be redundant with the global .gitignore for, and is provided
+# for redundancy. If the `.secrets` folder is not needed, you may delete it
+# from the project.
+
+*
+!.gitignore

README.md

@@ -0,0 +1,65 @@
+# tap-klaviyo
+
+This is a [Singer](https://singer.io) tap that produces JSON-formatted
+data from the Klaviyo API following the [Singer
+spec](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md).
+
+This tap:
+
+- Pulls raw data from the [Klaviyo metrics API](https://www.klaviyo.com/docs/api/metrics)
+- Outputs the schema for each resource
+- Incrementally pulls data based on the input state for incremental endpoints
+- Updates full tables for global exclusions and lists endpoints
+
+## Quick start
+
+1. Install
+
+   ```bash
+   > virtualenv -p python3 venv
+   > source venv/bin/activate
+   > pip install tap-klaviyo
+   ```
+
+2. Create the config file
+
+   Create a JSON file containing your API key or client ID and client Secret and start date.
+
+   ```json
+   {
+     "api_key": "pk_XYZ",
+     "start_date": "2017-01-01T00:00:00Z",
+     "client_id": "client_id",
+     "client_secret": "client_secret",
+   }
+   ```
+
+3. [Optional] Create the initial state file
+
+   You can provide JSON file that contains a date for the metrics endpoints to force the application to only fetch events since those dates. If you omit the file it will fetch all
+   commits and issues.
+
+   ```json
+   {
+     "bookmarks": {
+       "receive": { "since": "2017-04-01T00:00:00Z" },
+       "open": { "since": "2017-04-01T00:00:00Z" }
+     }
+   }
+   ```
+
+4. [Optional] Run discover command and save catalog into catalog file
+
+   ```bash
+   tap-klaviyo --config config.json --discover
+   ```
+
+5. Run the application
+
+   `tap-klaviyo` can be run with:
+
+   ```bash
+   tap-klaviyo --config config.json [--state state.json] [--catalog catalog.json]
+   ```
+
+---

meltano.yml

@@ -0,0 +1,25 @@
+version: 1
+send_anonymous_usage_stats: true
+project_id: tap-klaviyo-v2
+plugins:
+  extractors:
+  - name: tap-klaviyo-v2
+    namespace: tap_klaviyo
+    pip_url: -e .
+    capabilities:
+    - state
+    - catalog
+    - discover
+    config:
+      start_date: '2010-01-01T00:00:00Z'
+    settings:
+    # TODO: To configure using Meltano, declare settings and their types here:
+    - name: username
+    - name: password
+      kind: password
+    - name: start_date
+      value: '2010-01-01T00:00:00Z'
+  loaders:
+  - name: target-jsonl
+    variant: andyh1203
+    pip_url: target-jsonl

mypy.ini

@@ -0,0 +1,6 @@
+[mypy]
+python_version = 3.9
+warn_unused_configs = True
+
+[mypy-backoff.*]
+ignore_missing_imports = True

output/.gitignore

@@ -0,0 +1,4 @@
+# This directory is used as a target by target-jsonl, so ignore all files
+
+*
+!.gitignore

pyproject.toml

@@ -0,0 +1,39 @@
+[tool.poetry]
+name = "tap-klaviyo"
+version = "0.0.1"
+description = "`tap-klaviyo` is a Singer tap for Klaviyo, built with the Meltano SDK for Singer Taps."
+authors = ["Hotglue"]
+keywords = [
+    "ELT",
+    "Klaviyo",
+]
+license = "Apache 2.0"
+
+[tool.poetry.dependencies]
+python = "<3.11,>=3.7.1"
+requests = "^2.25.1"
+singer-sdk = "^0.5.0"
+"backports.cached-property" = "^1.0.1"
+
+[tool.poetry.dev-dependencies]
+pytest = "^6.2.5"
+tox = "^3.24.4"
+flake8 = "^3.9.2"
+black = "^21.9b0"
+pydocstyle = "^6.1.1"
+mypy = "^0.910"
+types-requests = "^2.26.1"
+isort = "^5.10.1"
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3 # Vertical Hanging Indent
+src_paths = "tap_klaviyo"
+
+[build-system]
+requires = ["poetry-core>=1.0.8"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.scripts]
+# CLI declaration
+tap-klaviyo-v2 = 'tap_klaviyo.tap:TapKlaviyo.cli'