Skip to content

Commit

Permalink
Added instructions on activating the proper env.
Browse files Browse the repository at this point in the history
  • Loading branch information
rpopov committed Jan 24, 2025
1 parent 241cdab commit 145a43a
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Thank you for being interested in contributing to Airbyte Python CDK! Here are s
Here are some tips to get started using the project dependencies and development tools:

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.
2. Make sure your Python version is 3.10 or 3.11
2. Make sure your Python version is 3.11

Fedora 41:

Expand All @@ -30,18 +30,10 @@ Fedora 41:
sudo dnf install pip
```

3. [Install pipx](https://pipx.pypa.io/stable/installation/)

Fedora 41:

```bash
sudo dnf install pipx
```

4. [Install Poetry](https://python-poetry.org/docs/#):
3. [Install Poetry](https://python-poetry.org/docs/#):

```bash
pipx install poetry
pip install poetry
```

or
Expand All @@ -55,13 +47,31 @@ Fedora 41:
sudo dnf install poetry
```

5. In the **airbyte-python-cdk project** install [Poe the Poet](https://poethepoet.natn.io/) and unit tests' prerequisites:
4 Use the Python 3.11 environment:

```bash
poetry env info
# validate 3.11 is active

# otherwise:
poetry env list
# remove any other environment:
poetry env remove <env>
# example: project_name-QI_LjVaV-py3.9

# Use the proper version:
poetry env use /usr/bin/python3.11
poetry env info
# validate 3.11 referred
```

5 In the **airbyte-python-cdk project** install [Poe the Poet](https://poethepoet.natn.io/) and unit tests' prerequisites:

```bash
poetry install --all-extras
```

6. If your operating system is RHEL or compatible, execute:
6 If your operating system is RHEL or compatible, execute:

```bash
# just for the current session, until restart
Expand Down

0 comments on commit 145a43a

Please sign in to comment.