Skip to content

Commit 07587ae

Browse files
alafanecherealafanechere
authored
✨ source-twilio: migrate to poetry (#35153)
1 parent 2c63c9f commit 07587ae

File tree

6 files changed

+1126
-146
lines changed

6 files changed

+1126
-146
lines changed

‎airbyte-integrations/connectors/source-twilio/README.md

Lines changed: 44 additions & 100 deletions
Original file line numberDiff line numberDiff line change
@@ -1,117 +1,55 @@
1-
# Twilio Source
1+
# Twilio source connector
2+
23

34
This is the repository for the Twilio 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/twilio).
5+
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/twilio).
56

67
## Local development
78

89
### Prerequisites
9-
**To iterate on this connector, make sure to complete this prerequisites section.**
10+
* Python (~=3.9)
11+
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
1012

11-
#### Build & Activate Virtual Environment and install dependencies
12-
From this connector directory, create a virtual environment:
13-
```
14-
python -m venv .venv
15-
```
1613

17-
This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
18-
development environment of choice. To activate it from the terminal, run:
19-
```
20-
source .venv/bin/activate
21-
pip install -r requirements.txt
14+
### Installing the connector
15+
From this connector directory, run:
16+
```bash
17+
poetry install --with dev
2218
```
23-
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
2419

25-
Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
26-
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
27-
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
28-
should work as you expect.
2920

30-
#### Create credentials
31-
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/twilio)
32-
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_twilio/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/twilio)
23+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_twilio/spec.yaml` file.
3324
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
34-
See `integration_tests/sample_config.json` for a sample config file.
25+
See `sample_files/sample_config.json` for a sample config file.
3526

36-
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source twilio test creds`
37-
and place them into `secrets/config.json`.
3827

3928
### Locally running the connector
4029
```
41-
python main.py spec
42-
python main.py check --config secrets/config.json
43-
python main.py discover --config secrets/config.json
44-
python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
30+
poetry run source-twilio spec
31+
poetry run source-twilio check --config secrets/config.json
32+
poetry run source-twilio discover --config secrets/config.json
33+
poetry run source-twilio read --config secrets/config.json --catalog sample_files/configured_catalog.json
4534
```
4635

47-
### Locally running the connector docker image
48-
49-
50-
51-
52-
#### Use `airbyte-ci` to build your connector
53-
The Airbyte way of building this connector is to use our `airbyte-ci` tool.
54-
You can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
55-
Then running the following command will build your connector:
56-
57-
```bash
58-
airbyte-ci connectors --name source-twilio build
36+
### Running unit tests
37+
To run unit tests locally, from the connector directory run:
5938
```
60-
Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-twilio:dev`.
61-
62-
##### Customizing our build process
63-
When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
64-
You can customize our build process by adding a `build_customization.py` module to your connector.
65-
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.
66-
It will be imported at runtime by our build process and the functions will be called if they exist.
67-
68-
Here is an example of a `build_customization.py` module:
69-
```python
70-
from __future__ import annotations
71-
72-
from typing import TYPE_CHECKING
73-
74-
if TYPE_CHECKING:
75-
# Feel free to check the dagger documentation for more information on the Container object and its methods.
76-
# https://dagger-io.readthedocs.io/en/sdk-python-v0.6.4/
77-
from dagger import Container
78-
79-
80-
async def pre_connector_install(base_image_container: Container) -> Container:
81-
return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")
82-
83-
async def post_connector_install(connector_container: Container) -> Container:
84-
return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")
39+
poetry run pytest unit_tests
8540
```
8641

87-
#### Build your own connector image
88-
This connector is built using our dynamic built process in `airbyte-ci`.
89-
The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
90-
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).
91-
It does not rely on a Dockerfile.
92-
93-
If you would like to patch our connector and build your own a simple approach would be to:
94-
95-
1. Create your own Dockerfile based on the latest version of the connector image.
96-
```Dockerfile
97-
FROM airbyte/source-twilio:latest
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:
45+
```bash
46+
airbyte-ci connectors --name=source-twilio build
47+
```
9848

99-
COPY . ./airbyte/integration_code
100-
RUN pip install ./airbyte/integration_code
49+
An image will be available on your host with the tag `airbyte/source-twilio:dev`.
10150

102-
# The entrypoint and default env vars are already set in the base image
103-
# ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
104-
# ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
105-
```
106-
Please use this as an example. This is not optimized.
10751

108-
2. Build your image:
109-
```bash
110-
docker build -t airbyte/source-twilio:dev .
111-
# Running the spec command against your patched connector
112-
docker run airbyte/source-twilio:dev spec
113-
```
114-
#### Run
52+
### Running as a docker container
11553
Then run any of the connector commands as follows:
11654
```
11755
docker run --rm airbyte/source-twilio:dev spec
@@ -120,28 +58,34 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-twilio:dev discover --
12058
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-twilio:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
12159
```
12260

123-
## Testing
61+
### Running our CI test suite
12462
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
12563
```bash
12664
airbyte-ci connectors --name=source-twilio test
12765
```
12866

12967
### Customizing acceptance Tests
130-
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.
13169
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.
13270

133-
## Dependency Management
134-
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.
135-
We split dependencies between two groups, dependencies that are:
136-
* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
137-
* 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.
13879

139-
### Publishing a new version of the connector
80+
## Publishing a new version of the connector
14081
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
14182
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-twilio test`
142-
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`
14386
3. Make sure the `metadata.yaml` content is up to date.
144-
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/twilio.md`).
87+
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/twilio.md`).
14588
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).
14689
6. Pat yourself on the back for being an awesome contributor.
14790
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-twilio/metadata.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ data:
1313
connectorSubtype: api
1414
connectorType: source
1515
definitionId: b9dc6155-672e-42ea-b10d-9f1f1fb95ab1
16-
dockerImageTag: 0.10.1
16+
dockerImageTag: 0.10.2
1717
dockerRepository: airbyte/source-twilio
1818
documentationUrl: https://docs.airbyte.com/integrations/sources/twilio
1919
githubIssueLabel: source-twilio

0 commit comments

Comments
 (0)