|
1 |
| -# Appsflyer Source |
| 1 | +# Appsflyer source connector |
| 2 | + |
2 | 3 |
|
3 | 4 | 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). |
5 | 6 |
|
6 | 7 | ## Local development
|
7 | 8 |
|
8 | 9 | ### Prerequisites
|
| 10 | +* Python (~=3.9) |
| 11 | +* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation) |
9 | 12 |
|
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: |
24 | 13 |
|
| 14 | +### Installing the connector |
| 15 | +From this connector directory, run: |
| 16 | +```bash |
| 17 | +poetry install --with dev |
25 | 18 | ```
|
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. |
36 | 19 |
|
37 |
| -#### Create credentials |
38 | 20 |
|
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. |
41 | 24 | 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. |
43 | 26 |
|
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`. |
46 | 27 |
|
47 | 28 | ### Locally running the connector
|
48 |
| - |
49 | 29 | ```
|
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 |
54 | 34 | ```
|
55 | 35 |
|
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 | +``` |
61 | 41 |
|
| 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: |
62 | 45 | ```bash
|
63 | 46 | airbyte-ci connectors --name=source-appsflyer build
|
64 | 47 | ```
|
65 | 48 |
|
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`. |
73 | 50 |
|
74 |
| -#### Run |
75 | 51 |
|
| 52 | +### Running as a docker container |
76 | 53 | Then run any of the connector commands as follows:
|
77 |
| - |
78 | 54 | ```
|
79 | 55 | docker run --rm airbyte/source-appsflyer:dev spec
|
80 | 56 | docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-appsflyer:dev check --config /secrets/config.json
|
81 | 57 | docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-appsflyer:dev discover --config /secrets/config.json
|
82 | 58 | 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
|
83 | 59 | ```
|
84 | 60 |
|
85 |
| -## Testing |
86 |
| - |
| 61 | +### Running our CI test suite |
87 | 62 | 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 |
| - |
89 | 63 | ```bash
|
90 | 64 | airbyte-ci connectors --name=source-appsflyer test
|
91 | 65 | ```
|
92 | 66 |
|
93 | 67 | ### 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. |
96 | 69 | 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.
|
97 | 70 |
|
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 | +``` |
105 | 77 |
|
106 |
| -### Publishing a new version of the connector |
| 78 | +Please commit the changes to `pyproject.toml` and `poetry.lock` files. |
107 | 79 |
|
| 80 | +## Publishing a new version of the connector |
108 | 81 | 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 |
| - |
110 | 82 | 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` |
112 | 86 | 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`). |
114 | 88 | 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).
|
115 | 89 | 6. Pat yourself on the back for being an awesome contributor.
|
116 | 90 | 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. |
0 commit comments