airbyte-source-linnworks

Linnworks Source

This is the repository for the Linnworks source connector, written in Python. For information about how to use this connector within Airbyte, see the documentation.

Local development

Prerequisites

• Python (~=3.9)
• Poetry (~=1.7) - installation instructions here

Installing the connector

From this connector directory, run:

poetry install --with dev

Create credentials

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_linnworks/spec.yaml 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 integration_tests/sample_config.json for a sample config file.

Locally running the connector

poetry run source-linnworks spec
poetry run source-linnworks check --config secrets/config.json
poetry run source-linnworks discover --config secrets/config.json
poetry run source-linnworks read --config secrets/config.json --catalog integration_tests/configured_catalog.json

Running unit tests

To run unit tests locally, from the connector directory run:

poetry run pytest unit_tests

Locally running the connector docker image

Use airbyte-ci to build your connector

The Airbyte way of building this connector is to use our airbyte-ci tool. You can follow install instructions here. Then running the following command will build your connector:

airbyte-ci connectors --name source-linnworks build

Once the command is done, you will find your connector image in your local docker registry: airbyte/source-linnworks:dev.

Customizing our build process

When contributing on our connector you might need to customize the build process to add a system dependency or set an env var. You can customize our build process by adding a build_customization.py module to your connector. This module should contain a pre_connector_install and post_connector_install async function that will mutate the base image and the connector container respectively. It will be imported at runtime by our build process and the functions will be called if they exist.

Here is an example of a build_customization.py module:

from __future__ import annotations

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    # Feel free to check the dagger documentation for more information on the Container object and its methods.
    # https://dagger-io.readthedocs.io/en/sdk-python-v0.6.4/
    from dagger import Container


async def pre_connector_install(base_image_container: Container) -> Container:
    return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")

async def post_connector_install(connector_container: Container) -> Container:
    return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")

Build your own connector image

This connector is built using our dynamic built process in airbyte-ci. The base image used to build it is defined within the metadata.yaml file under the connectorBuildOptions. The build logic is defined using Dagger here. It does not rely on a Dockerfile.

If you would like to patch our connector and build your own a simple approach would be to:

• Create your own Dockerfile based on the latest version of the connector image.

FROM airbyte/source-linnworks:latest

COPY . ./airbyte/integration_code
RUN pip install ./airbyte/integration_code

# The entrypoint and default env vars are already set in the base image
# ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
# ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]

Please use this as an example. This is not optimized.

• Build your image:

docker build -t airbyte/source-linnworks:dev .
# Running the spec command against your patched connector
docker run airbyte/source-linnworks:dev spec

Run

Then run any of the connector commands as follows:

docker run --rm airbyte/source-linnworks:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-linnworks:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-linnworks:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-linnworks:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json

Testing

You can run our full test suite locally using airbyte-ci:

airbyte-ci connectors --name=source-linnworks test

Customizing acceptance Tests

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.

Dependency Management

All of your dependencies should be managed via Poetry.

To add a new dependency, run:

poetry add <package-name>

Please commit the changes to pyproject.toml and poetry.lock files.

Publishing a new version of the connector

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-linnworks test
• Bump the connector version in metadata.yaml: increment the dockerImageTag value. Please follow semantic versioning for connectors.
• Make sure the metadata.yaml content is up to date.
• Make the connector documentation and its changelog is up to date (docs/integrations/sources/linnworks.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.