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
Copy file name to clipboardExpand all lines: docs/CONTRIBUTING.md
+8-15Lines changed: 8 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,7 @@ Thank you for being interested in contributing to Airbyte Python CDK! Here are s
13
13
14
14
Here are some tips to get started using the project dependencies and development tools:
15
15
16
-
1. Clone the CDK repo. If you will be testing connectors, you should clone the CDK into the same parent directory as `airbytehq/airbyte`, which contains the connector definitions.
17
16
1. Make sure your Python version is 3.11
18
-
1. Make sure [Poetry is installed](https://python-poetry.org/docs/#) (version 2.0 or higher).
19
-
1. Run `poetry install --all-extras`.
20
-
1. Unit tests can be run via `poetry run pytest`.
21
-
22
-
Note: By default in Poetry 2.0, `poetry lock` only refreshes the lockfile without pulling new versions. This is the same behavior as the previous `poetry lock --no-update` command.
23
-
1. You can use "Poe" tasks to perform common actions such as lint checks (`poetry run poe lint`), autoformatting (`poetry run poe format-fix`), etc. For a list of tasks you can run, try `poetry run poe list`.
3.[Install Poetry](https://python-poetry.org/docs/#) 2.0 or higher:
41
33
42
34
```bash
43
35
pip install poetry
@@ -53,6 +45,7 @@ Fedora 41:
53
45
```bash
54
46
sudo dnf install poetry
55
47
```
48
+
Note: You can use "Poe" tasks to perform common actions such as lint checks (`poetry run poe lint`), autoformatting (`poetry run poe format-fix`), etc. For a list of tasks you can run, try `poetry run poe list`. See [Poe the Poet](https://poethepoet.natn.io/)
56
49
57
50
4 Use the Python 3.11 environment:
58
51
@@ -69,13 +62,15 @@ poetry env info
69
62
# validate 3.11 referred
70
63
```
71
64
72
-
5 In the **airbyte-python-cdk project** install [Poe the Poet](https://poethepoet.natn.io/) and unit tests' prerequisites:
65
+
5. Clone the CDK repo. If you will be testing connectors, you should clone the CDK into the same parent directory as `airbytehq/airbyte`, which contains the connector definitions.
66
+
6. In the **airbyte-python-cdk project** install the unit tests' prerequisites:
73
67
74
68
```bash
75
69
poetry install --all-extras
76
70
```
71
+
Note: By default in Poetry 2.0, `poetry lock` only refreshes the lockfile without pulling new versions. This is the same behavior as the previous `poetry lock --no-update` command.
77
72
78
-
6 If your operating system is RHEL or compatible, execute:
73
+
7 If your operating system is RHEL or compatible, execute:
8. Edit airbyte/airbyte-integrations/connectors/source-shopify/acceptance-test-config.yml and change:
93
+
9. Edit airbyte/airbyte-integrations/connectors/source-shopify/acceptance-test-config.yml and change:
99
94
100
95
```
101
96
connector_image: airbyte/source-shopify:dev to connector_image: airbyte/source-shopify:<version>
@@ -280,8 +275,6 @@ The Airbyte CDK defines common development tasks using [Poe the Poet](https://po
280
275
Optionally, if you can [pre-install Poe](https://poethepoet.natn.io/installation.html) with `pipx install poethepoet` and then you will be able to run Poe tasks with the shorter `poe TASKNAME` syntax instead of `poetry run poe TASKNAME`.
281
276
The Ruff configuration is stored in `ruff.toml` at the root of the repository. This file contains settings for line length, target Python version, and linting rules.
282
277
283
-
The Ruff configuration is stored in `ruff.toml` at the root of the repository. This file contains settings for line length, target Python version, and linting rules.
284
-
285
278
## Auto-Generating the Declarative Schema File
286
279
287
280
Low-code CDK models are generated from `sources/declarative/declarative_component_schema.yaml`. If the iteration you are working on includes changes to the models or the connector generator, you may need to regenerate them. To do that, you can run:
0 commit comments