airbyte-source-news-api

News-Api source connector

This is the repository for the News Api configuration based source connector. 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 src/source_news_api/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 sample_files/sample_config.json for a sample config file.

Locally running the connector

poetry run source-news-api spec
poetry run source-news-api check --config secrets/config.json
poetry run source-news-api discover --config secrets/config.json
poetry run source-news-api read --config secrets/config.json --catalog sample_files/configured_catalog.json

Running tests

To run tests locally, from the connector directory run:

poetry run pytest tests

Building the docker image

• Install airbyte-ci
• Run the following command to build the docker image:

airbyte-ci connectors --name=source-news-api build

An image will be available on your host with the tag airbyte/source-news-api:dev.

Running as a docker container

Then run any of the connector commands as follows:

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

Running our CI test suite

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

airbyte-ci connectors --name=source-news-api test

Customizing acceptance Tests

Customize acceptance-test-config.yml file to configure acceptance 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-news-api test
• Bump the connector version (please follow semantic versioning for connectors):
  • bump the dockerImageTag value in in metadata.yaml
  • bump the version value in pyproject.toml
• Make sure the metadata.yaml content is up to date.
• Make sure the connector documentation and its changelog is up to date (docs/integrations/sources/news-api.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.
• Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.