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

Local development

Prerequisites

To iterate on this connector, make sure to complete this prerequisites section.

Build & Activate Virtual Environment and install dependencies

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.

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_scaffold_source_python/spec.json file. Note that the secrets directory is gitignored by default, 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 scaffold-source-python test creds and place them into secrets/config.json.

Locally running the connector

python main_dev.py spec
python main_dev.py check --config secrets/config.json
python main_dev.py discover --config secrets/config.json
python main_dev.py read --config secrets/config.json --catalog sample_files/configured_catalog.json

Unit Tests

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

python -m pytest unit_tests

Locally running the connector docker image

First, make sure you build the latest Docker image:

docker build . -t airbyte/scaffold-source-python:dev

Then run any of the connector commands as follows:

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

Integration Tests

From the airbyte project root, run ./gradlew :airbyte-integrations:connectors:source-scaffold-source-python:integrationTest to run the standard integration test suite.
To run additional integration tests, place your integration tests in a new directory integration_tests and run them with python -m pytest -s integration_tests. Make sure to familiarize yourself with pytest test discovery to know how your test files and methods should be named.

Dependency Management

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.