You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is the repository for the Amplitude configuration based source connector.
3
+
4
+
This is the repository for the Amplitude source connector, written in Python.
4
5
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/amplitude).
5
6
6
7
## Local development
7
8
8
-
#### Create credentials
9
-
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/amplitude)
10
-
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_amplitude/spec.yaml` file.
11
-
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
12
-
See `integration_tests/sample_config.json` for a sample config file.
13
-
14
-
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source amplitude test creds`
Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-amplitude:dev`.
30
-
31
-
##### Customizing our build process
32
-
When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
33
-
You can customize our build process by adding a `build_customization.py` module to your connector.
34
-
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.
35
-
It will be imported at runtime by our build process and the functions will be called if they exist.
36
-
37
-
Here is an example of a `build_customization.py` module:
38
-
```python
39
-
from__future__import annotations
40
-
41
-
from typing importTYPE_CHECKING
42
19
43
-
ifTYPE_CHECKING:
44
-
# Feel free to check the dagger documentation for more information on the Container object and its methods.
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/amplitude)
23
+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_amplitude/spec.yaml` file.
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.
25
+
See `sample_files/sample_config.json` for a sample config file.
poetry run source-amplitude check --config secrets/config.json
32
+
poetry run source-amplitude discover --config secrets/config.json
33
+
poetry run source-amplitude read --config secrets/config.json --catalog sample_files/configured_catalog.json
54
34
```
55
35
56
-
#### Build your own connector image
57
-
This connector is built using our dynamic built process in `airbyte-ci`.
58
-
The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
59
-
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).
60
-
It does not rely on a Dockerfile.
61
-
62
-
If you would like to patch our connector and build your own a simple approach would be to:
63
-
64
-
1. Create your own Dockerfile based on the latest version of the connector image.
65
-
```Dockerfile
66
-
FROM airbyte/source-amplitude:latest
67
-
68
-
COPY . ./airbyte/integration_code
69
-
RUN pip install ./airbyte/integration_code
70
-
71
-
# The entrypoint and default env vars are already set in the base image
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
94
63
```bash
95
64
airbyte-ci connectors --name=source-amplitude test
96
65
```
97
66
98
67
### Customizing acceptance Tests
99
-
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.
100
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.
101
70
102
-
## Dependency Management
103
-
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.
104
-
We split dependencies between two groups, dependencies that are:
105
-
* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
106
-
* 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
+
```
77
+
78
+
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
107
79
108
-
###Publishing a new version of the connector
80
+
## Publishing a new version of the connector
109
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?
110
82
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-amplitude 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/amplitude.md`).
87
+
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/amplitude.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.
117
-
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