This release is a pre-release and may not be stable for production use.
Klaviyo Source
This is the repository for the Klaviyo source connector, written in Python. For information about how to use this connector within Airbyte, see the documentation.
This source is currently migrating from the v1 of Klaviyo API to the latest stable API version, v2023-02-22. Review the api comparison chart to see major changes.
To iterate on this connector, make sure to complete this prerequisites section.
From this connector directory, create a virtual environment:
python -m venv .venv
This will generate a virtualenv for this module in .venv/. Make sure this venv is active in your
development environment of choice. To activate it from the terminal, run:
source .venv/bin/activate
pip install -r requirements.txt
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
Note that while we are installing dependencies from requirements.txt, you should only edit setup.py for your dependencies. requirements.txt is
used for editable installs (pip install -e) to pull in Python dependencies from the monorepo and will call setup.py.
If this is mumbo jumbo to you, don't worry about it, just put your deps in setup.py but install using pip install -r requirements.txt and everything
should work as you expect.
If you are a community contributor, follow the instructions in the documentation
to generate the necessary credentials. Then create a file secrets/config.json conforming to the source_klaviyo/spec.json file.
Note that any directory named secrets is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
See sample_files/sample_config.json for a sample config file.
If you are an Airbyte core member, copy the credentials in Lastpass under the secret name source klaviyo test creds
and place them into secrets/config.json.
python main.py spec
python main.py check --config secrets/config.json
python main.py discover --config secrets/config.json
python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
Via airbyte-ci (recommended):
airbyte-ci connectors --name=source-klaviyo build
An image will be built with the tag airbyte/source-klaviyo:dev.
Via docker build:
docker build -t airbyte/source-klaviyo:dev .
Then run any of the connector commands as follows:
docker run --rm airbyte/source-klaviyo:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-klaviyo:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-klaviyo:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/sample_files:/sample_files airbyte/source-klaviyo:dev read --config /secrets/config.json --catalog /sample_files/configured_catalog.json
You can run our full test suite locally using airbyte-ci:
airbyte-ci connectors --name=source-klaviyo test
Customize acceptance-test-config.yml file to configure tests. See Connector Acceptance Tests for more information.
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
All of your dependencies should go in setup.py, NOT requirements.txt. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
We split dependencies between two groups, dependencies that are:
- required for your connector to work need to go to
MAIN_REQUIREMENTSlist. - required for the testing need to go to
TEST_REQUIREMENTSlist
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
- Make sure your changes are passing our test suite:
airbyte-ci connectors --name=source-klaviyo test - Bump the connector version in
metadata.yaml: increment thedockerImageTagvalue. Please follow semantic versioning for connectors. - Make sure the
metadata.yamlcontent is up to date. - Make the connector documentation and its changelog is up to date (
docs/integrations/sources/klaviyo.md). - Create a Pull Request: use our PR naming conventions.
- Pat yourself on the back for being an awesome contributor.
- Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
1 maintainer
Metadata
1 maintainer
Release files for airbyte-source-klaviyo 2.1.0.dev202402012225
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| airbyte-source-klaviyo-2.1.0.dev202402012225.tar.gz | 12.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| airbyte_source_klaviyo-2.1.0.dev202402012225-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 29.3 kB
Release files / airbyte-source-klaviyo-2.1.0.dev202402012225.tar.gz
| Download URL | airbyte-source-klaviyo-2.1.0.dev202402012225.tar.gz |
|---|---|
| Size | 12.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2a4c8ea234e778f91493a388a4f37fcaa2ba5ae503ab99c18b16dae38302da23
|
|
BLAKE2b-256 checksum How to use checksums |
5b60408c410de61a9b5ca3c8427f91bbce04c8cad6a85ed856276f283ec5d8a8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
Release files / airbyte_source_klaviyo-2.1.0.dev202402012225-py3-none-any.whl
| Download URL | airbyte_source_klaviyo-2.1.0.dev202402012225-py3-none-any.whl |
|---|---|
| Size | 16.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d20c00913527da522740594693e123f018639f53bf7febbbef6a299262c66742
|
|
BLAKE2b-256 checksum How to use checksums |
03c6a4e53d6b65a5e287768ad90f4895767c9adbe19526f8366caf63f8e8cced
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.2
|
