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
#### Build & Activate Virtual Environment and install dependencies
14
-
15
-
From this connector directory, create a virtual environment:
16
-
17
-
```
18
-
python -m venv .venv
19
-
```
20
-
21
-
This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
22
-
development environment of choice. To activate it from the terminal, run:
23
-
24
-
```
25
-
source .venv/bin/activate
26
-
pip install -r requirements.txt
15
+
From this connector directory, run:
16
+
```bash
17
+
poetry install --with dev
27
18
```
28
19
29
-
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
30
-
31
-
Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
32
-
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
33
-
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
34
-
should work as you expect.
20
+
### Create credentials
35
21
36
-
#### Create credentials
22
+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/lever-hiring)
23
+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_lever_hiring/spec.yaml` file.
37
24
38
-
**If you are a community contributor**, get the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_lever_hiring/spec.json` file.
39
25
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
40
-
See `integration_tests/sample_config.json` for a sample config file.
41
-
42
-
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source lever-hiring test creds`
43
-
and place them into `secrets/config.json`.
26
+
See `sample_files/sample_config.json` for a sample config file.
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
86
70
@@ -90,25 +74,30 @@ airbyte-ci connectors --name=source-lever-hiring test
90
74
91
75
### Customizing acceptance Tests
92
76
93
-
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.
77
+
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.
94
78
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.
95
79
96
-
## Dependency Management
80
+
###Dependency Management
97
81
98
-
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.
99
-
We split dependencies between two groups, dependencies that are:
82
+
All of your dependencies should be managed via Poetry.
83
+
To add a new dependency, run:
84
+
```bash
85
+
poetry add <package-name>
86
+
```
100
87
101
-
- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
102
-
- required for the testing need to go to `TEST_REQUIREMENTS` list
88
+
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
103
89
104
-
###Publishing a new version of the connector
90
+
## Publishing a new version of the connector
105
91
106
92
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
107
93
108
94
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-lever-hiring test`
109
-
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).
95
+
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)):
96
+
- bump the `dockerImageTag` value in in `metadata.yaml`
97
+
- bump the `version` value in `pyproject.toml`
110
98
3. Make sure the `metadata.yaml` content is up to date.
111
-
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/lever-hiring.md`).
99
+
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/lever-hiring.md`).
112
100
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).
113
101
6. Pat yourself on the back for being an awesome contributor.
114
102
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
103
+
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