airbyte-lib 0.1.0.dev2

AirbyteLib

airbyte-lib

airbyte-lib is a library that allows to run Airbyte syncs embedded into any Python application, without the need to run Airbyte server.

Development

• Make sure Poetry is installed.
• Run poetry install
• For examples, check out the examples folder. They can be run via poetry run python examples/<example file>
• Unit tests and type checks can be run via poetry run pytest

Release

• In your PR:
  • Bump the version in pyproject.toml
  • Add a changelog entry to the table below
• Once the PR is merged, go to Github and trigger the Publish AirbyteLib Manually workflow. This will publish the new version to PyPI.

Versioning

Versioning follows Semantic Versioning. For new features, bump the minor version. For bug fixes, bump the patch version. For pre-releases, append dev.N to the version. For example, 0.1.0dev.1 is the first pre-release of the 0.1.0 version.

Documentation

Regular documentation lives in the /docs folder. Based on the doc strings of public methods, we generate API documentation using pdoc. To generate the documentation, run poetry run generate-docs. The documentation will be generated in the docs/generate folder. This needs to be done manually when changing the public interface of the library.

A unit test validates the documentation is up to date.

Validating source connectors

To validate a source connector for compliance, the airbyte-lib-validate-source script can be used. It can be used like this:

airbyte-lib-validate-source —connector-dir . -—sample-config secrets/config.json

The script will install the python package in the provided directory, and run the connector against the provided config. The config should be a valid JSON file, with the same structure as the one that would be provided to the connector in Airbyte. The script will exit with a non-zero exit code if the connector fails to run.

For a more lightweight check, the --validate-install-only flag can be used. This will only check that the connector can be installed and returns a spec, no sample config required.

Changelog

Version	PR	Description
0.1.0dev.2	#34111	Initial publish - add publish workflow