# Outbrain Amplify Source
This is the repository for the Outbrain Amplify source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/outbrain-amplify).
## Local development
### Prerequisites
**To iterate on this connector, make sure to complete this prerequisites section.**
#### Minimum Python version required `= 3.9.0`
#### 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
pip install '.[tests]'
```
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](https://docs.airbyte.com/integrations/sources/outbrain-amplify)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_outbrain_amplify/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.
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source outbrain-amplify test creds`
and place them into `secrets/config.json`.
### Locally running the connector
```
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
```
### 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](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
Then running the following command will build your connector:
```bash
airbyte-ci connectors --name source-outbrain-amplify build
```
Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-outbrain-amplify: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:
```python
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](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).
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:
1. Create your own Dockerfile based on the latest version of the connector image.
```Dockerfile
FROM airbyte/source-outbrain-amplify: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.
2. Build your image:
```bash
docker build -t airbyte/source-outbrain-amplify:dev .
# Running the spec command against your patched connector
docker run airbyte/source-outbrain-amplify:dev spec
```
#### Run
Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-outbrain-amplify:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-outbrain-amplify:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-outbrain-amplify:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-outbrain-amplify:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
## Testing
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
```bash
airbyte-ci connectors --name=source-outbrain-amplify test
```
### Customizing acceptance Tests
Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) 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 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_REQUIREMENTS` list.
- required for the testing need to go to `TEST_REQUIREMENTS` list
### 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?
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-outbrain-amplify test`
2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).
3. Make sure the `metadata.yaml` content is up to date.
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/outbrain-amplify.md`).
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
6. Pat yourself on the back for being an awesome contributor.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
Raw data
{
"_id": null,
"home_page": "https://airbyte.com",
"name": "airbyte-source-outbrain-amplify",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.12,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Airbyte",
"author_email": "contact@airbyte.io",
"download_url": "https://files.pythonhosted.org/packages/be/61/ec34ed467de59a1aa1e9c0459bded7637453acdfe0931db72550036a2261/airbyte_source_outbrain_amplify-0.1.24.tar.gz",
"platform": null,
"description": "# Outbrain Amplify Source\n\nThis is the repository for the Outbrain Amplify source connector, written in Python.\nFor information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/outbrain-amplify).\n\n## Local development\n\n### Prerequisites\n\n**To iterate on this connector, make sure to complete this prerequisites section.**\n\n#### Minimum Python version required `= 3.9.0`\n\n#### Build & Activate Virtual Environment and install dependencies\n\nFrom this connector directory, create a virtual environment:\n\n```\npython -m venv .venv\n```\n\nThis will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your\ndevelopment environment of choice. To activate it from the terminal, run:\n\n```\nsource .venv/bin/activate\npip install -r requirements.txt\npip install '.[tests]'\n```\n\nIf you are in an IDE, follow your IDE's instructions to activate the virtualenv.\n\nNote that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is\nused for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.\nIf 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\nshould work as you expect.\n\n#### Create credentials\n\n**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/outbrain-amplify)\nto generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_outbrain_amplify/spec.yaml` file.\nNote that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.\nSee `integration_tests/sample_config.json` for a sample config file.\n\n**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source outbrain-amplify test creds`\nand place them into `secrets/config.json`.\n\n### Locally running the connector\n\n```\npython main.py spec\npython main.py check --config secrets/config.json\npython main.py discover --config secrets/config.json\npython main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json\n```\n\n### Locally running the connector docker image\n\n\n\n#### Use `airbyte-ci` to build your connector\nThe Airbyte way of building this connector is to use our `airbyte-ci` tool.\nYou can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).\nThen running the following command will build your connector:\n\n```bash\nairbyte-ci connectors --name source-outbrain-amplify build\n```\nOnce the command is done, you will find your connector image in your local docker registry: `airbyte/source-outbrain-amplify:dev`.\n\n##### Customizing our build process\nWhen contributing on our connector you might need to customize the build process to add a system dependency or set an env var.\nYou can customize our build process by adding a `build_customization.py` module to your connector.\nThis module should contain a `pre_connector_install` and `post_connector_install` async function that will mutate the base image and the connector container respectively.\nIt will be imported at runtime by our build process and the functions will be called if they exist.\n\nHere is an example of a `build_customization.py` module:\n```python\nfrom __future__ import annotations\n\nfrom typing import TYPE_CHECKING\n\nif TYPE_CHECKING:\n # Feel free to check the dagger documentation for more information on the Container object and its methods.\n # https://dagger-io.readthedocs.io/en/sdk-python-v0.6.4/\n from dagger import Container\n\n\nasync def pre_connector_install(base_image_container: Container) -> Container:\n return await base_image_container.with_env_variable(\"MY_PRE_BUILD_ENV_VAR\", \"my_pre_build_env_var_value\")\n\nasync def post_connector_install(connector_container: Container) -> Container:\n return await connector_container.with_env_variable(\"MY_POST_BUILD_ENV_VAR\", \"my_post_build_env_var_value\")\n```\n\n#### Build your own connector image\nThis connector is built using our dynamic built process in `airbyte-ci`.\nThe base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.\nThe build logic is defined using [Dagger](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).\nIt does not rely on a Dockerfile.\n\nIf you would like to patch our connector and build your own a simple approach would be to:\n\n1. Create your own Dockerfile based on the latest version of the connector image.\n```Dockerfile\nFROM airbyte/source-outbrain-amplify:latest\n\nCOPY . ./airbyte/integration_code\nRUN pip install ./airbyte/integration_code\n\n# The entrypoint and default env vars are already set in the base image\n# ENV AIRBYTE_ENTRYPOINT \"python /airbyte/integration_code/main.py\"\n# ENTRYPOINT [\"python\", \"/airbyte/integration_code/main.py\"]\n```\nPlease use this as an example. This is not optimized.\n\n2. Build your image:\n```bash\ndocker build -t airbyte/source-outbrain-amplify:dev .\n# Running the spec command against your patched connector\ndocker run airbyte/source-outbrain-amplify:dev spec\n```\n#### Run\n\nThen run any of the connector commands as follows:\n\n```\ndocker run --rm airbyte/source-outbrain-amplify:dev spec\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-outbrain-amplify:dev check --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets airbyte/source-outbrain-amplify:dev discover --config /secrets/config.json\ndocker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-outbrain-amplify:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json\n```\n\n## Testing\n\nYou can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):\n\n```bash\nairbyte-ci connectors --name=source-outbrain-amplify test\n```\n\n### Customizing acceptance Tests\n\nCustomize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.\nIf 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.\n\n## Dependency Management\n\nAll 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.\nWe split dependencies between two groups, dependencies that are:\n\n- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.\n- required for the testing need to go to `TEST_REQUIREMENTS` list\n\n### Publishing a new version of the connector\n\nYou've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?\n\n1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-outbrain-amplify test`\n2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).\n3. Make sure the `metadata.yaml` content is up to date.\n4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/outbrain-amplify.md`).\n5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).\n6. Pat yourself on the back for being an awesome contributor.\n7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Source implementation for outbrain amplify.",
"version": "0.1.24",
"project_urls": {
"Documentation": "https://docs.airbyte.com/integrations/sources/outbrain-amplify",
"Homepage": "https://airbyte.com",
"Repository": "https://github.com/airbytehq/airbyte"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c8b11d04d19297ea2aec0a576ca421b2732421e3ed163fdda3d5d109b3c948a0",
"md5": "330508047b6ea68651d5353278c2a445",
"sha256": "4ddd24c3171438d0691ef8202d73f752b984024972693b36ef81614dcd3524a3"
},
"downloads": -1,
"filename": "airbyte_source_outbrain_amplify-0.1.24-py3-none-any.whl",
"has_sig": false,
"md5_digest": "330508047b6ea68651d5353278c2a445",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.12,>=3.9",
"size": 21811,
"upload_time": "2024-12-22T01:06:57",
"upload_time_iso_8601": "2024-12-22T01:06:57.515242Z",
"url": "https://files.pythonhosted.org/packages/c8/b1/1d04d19297ea2aec0a576ca421b2732421e3ed163fdda3d5d109b3c948a0/airbyte_source_outbrain_amplify-0.1.24-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be61ec34ed467de59a1aa1e9c0459bded7637453acdfe0931db72550036a2261",
"md5": "3c50c0d962e5736da7060b02587ffdc8",
"sha256": "af635b051d98709624ffb7dc2d0c7535587dd43e8e0b4e7acce1dfac46ded946"
},
"downloads": -1,
"filename": "airbyte_source_outbrain_amplify-0.1.24.tar.gz",
"has_sig": false,
"md5_digest": "3c50c0d962e5736da7060b02587ffdc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.12,>=3.9",
"size": 14607,
"upload_time": "2024-12-22T01:07:00",
"upload_time_iso_8601": "2024-12-22T01:07:00.257531Z",
"url": "https://files.pythonhosted.org/packages/be/61/ec34ed467de59a1aa1e9c0459bded7637453acdfe0931db72550036a2261/airbyte_source_outbrain_amplify-0.1.24.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-22 01:07:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "airbytehq",
"github_project": "airbyte",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "airbyte-source-outbrain-amplify"
}
JSON
