Skip to content

Commit 076be0b

Browse files
authored
source-appsflyer: Updating python deps and base image (#38363)
1 parent 429a094 commit 076be0b

File tree

6 files changed

+1117
-160
lines changed

6 files changed

+1117
-160
lines changed

airbyte-integrations/connectors/source-appsflyer/Dockerfile

-38
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1,116 +1,91 @@
1-
# Appsflyer Source
1+
# Appsflyer source connector
2+
23

34
This is the repository for the Appsflyer source connector, written in Python.
4-
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/appsflyer).
5+
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/appsflyer).
56

67
## Local development
78

89
### Prerequisites
10+
* Python (~=3.9)
11+
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
912

10-
**To iterate on this connector, make sure to complete this prerequisites section.**
11-
12-
#### Minimum Python version required `= 3.7.0`
13-
14-
#### Build & Activate Virtual Environment and install dependencies
15-
16-
From this connector directory, create a virtual environment:
17-
18-
```
19-
python -m venv .venv
20-
```
21-
22-
This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
23-
development environment of choice. To activate it from the terminal, run:
2413

14+
### Installing the connector
15+
From this connector directory, run:
16+
```bash
17+
poetry install --with dev
2518
```
26-
source .venv/bin/activate
27-
pip install -r requirements.txt
28-
```
29-
30-
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
31-
32-
Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
33-
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
34-
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
35-
should work as you expect.
3619

37-
#### Create credentials
3820

39-
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/appsflyer)
40-
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_appsflyer/spec.json` file.
21+
### Create credentials
22+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/appsflyer)
23+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_appsflyer/spec.yaml` file.
4124
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
42-
See `integration_tests/sample_config.json` for a sample config file.
25+
See `sample_files/sample_config.json` for a sample config file.
4326

44-
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source appsflyer test creds`
45-
and place them into `secrets/config.json`.
4627

4728
### Locally running the connector
48-
4929
```
50-
python main.py spec
51-
python main.py check --config secrets/config.json
52-
python main.py discover --config secrets/config.json
53-
python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
30+
poetry run source-appsflyer spec
31+
poetry run source-appsflyer check --config secrets/config.json
32+
poetry run source-appsflyer discover --config secrets/config.json
33+
poetry run source-appsflyer read --config secrets/config.json --catalog sample_files/configured_catalog.json
5434
```
5535

56-
### Locally running the connector docker image
57-
58-
#### Build
59-
60-
**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
36+
### Running unit tests
37+
To run unit tests locally, from the connector directory run:
38+
```
39+
poetry run pytest unit_tests
40+
```
6141

42+
### Building the docker image
43+
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
44+
2. Run the following command to build the docker image:
6245
```bash
6346
airbyte-ci connectors --name=source-appsflyer build
6447
```
6548

66-
An image will be built with the tag `airbyte/source-appsflyer:dev`.
67-
68-
**Via `docker build`:**
69-
70-
```bash
71-
docker build -t airbyte/source-appsflyer:dev .
72-
```
49+
An image will be available on your host with the tag `airbyte/source-appsflyer:dev`.
7350

74-
#### Run
7551

52+
### Running as a docker container
7653
Then run any of the connector commands as follows:
77-
7854
```
7955
docker run --rm airbyte/source-appsflyer:dev spec
8056
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-appsflyer:dev check --config /secrets/config.json
8157
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-appsflyer:dev discover --config /secrets/config.json
8258
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-appsflyer:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
8359
```
8460

85-
## Testing
86-
61+
### Running our CI test suite
8762
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
88-
8963
```bash
9064
airbyte-ci connectors --name=source-appsflyer test
9165
```
9266

9367
### Customizing acceptance Tests
94-
95-
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.
68+
Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
9669
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.
9770

98-
## Dependency Management
99-
100-
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.
101-
We split dependencies between two groups, dependencies that are:
102-
103-
- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
104-
- required for the testing need to go to `TEST_REQUIREMENTS` list
71+
### Dependency Management
72+
All of your dependencies should be managed via Poetry.
73+
To add a new dependency, run:
74+
```bash
75+
poetry add <package-name>
76+
```
10577

106-
### Publishing a new version of the connector
78+
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
10779

80+
## Publishing a new version of the connector
10881
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
109-
11082
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-appsflyer test`
111-
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).
83+
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
84+
- bump the `dockerImageTag` value in in `metadata.yaml`
85+
- bump the `version` value in `pyproject.toml`
11286
3. Make sure the `metadata.yaml` content is up to date.
113-
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/appsflyer.md`).
87+
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/appsflyer.md`).
11488
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).
11589
6. Pat yourself on the back for being an awesome contributor.
11690
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
91+
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

airbyte-integrations/connectors/source-appsflyer/metadata.yaml

+14-11
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ data:
22
connectorSubtype: api
33
connectorType: source
44
definitionId: 16447954-e6a8-4593-b140-43dea13bc457
5-
dockerImageTag: 0.1.0
5+
dockerImageTag: 0.1.1
66
dockerRepository: airbyte/source-appsflyer
77
githubIssueLabel: source-appsflyer
88
icon: appsflyer.svg
@@ -20,19 +20,22 @@ data:
2020
releaseStage: alpha
2121
documentationUrl: https://docs.airbyte.com/integrations/sources/appsflyer
2222
tags:
23-
- language:python
24-
- cdk:python
23+
- language:python
24+
- cdk:python
2525
ab_internal:
2626
sl: 100
2727
ql: 100
2828
supportLevel: community
2929
connectorTestSuitesOptions:
30-
- suite: unitTests
31-
- suite: acceptanceTests
32-
testSecrets:
33-
- name: SECRET_SOURCE-APPSFLYER_CREDS
34-
fileName: config.json
35-
secretStore:
36-
type: GSM
37-
alias: airbyte-connector-testing-secret-store
30+
- suite: unitTests
31+
- suite: acceptanceTests
32+
testSecrets:
33+
- name: SECRET_SOURCE-APPSFLYER_CREDS
34+
fileName: config.json
35+
secretStore:
36+
type: GSM
37+
alias: airbyte-connector-testing-secret-store
38+
connectorBuildOptions:
39+
baseImage:
40+
docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
3841
metadataSpecVersion: "1.0"

0 commit comments

Comments
 (0)