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: airbyte-integrations/connectors/source-auth0/README.md
+8-58Lines changed: 8 additions & 58 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,35 +1,10 @@
1
1
# Auth0 Source
2
2
3
-
This is the repository for the Auth0 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/auth0).
3
+
This is the repository for the Auth0 configuration based source connector.
4
+
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/auth0).
5
5
6
6
## Local development
7
7
8
-
### Prerequisites
9
-
**To iterate on this connector, make sure to complete this prerequisites section.**
10
-
11
-
#### Minimum Python version required `= 3.9.0`
12
-
13
-
#### Build & Activate Virtual Environment and install dependencies
14
-
From this connector directory, create a virtual environment:
15
-
```
16
-
python -m venv .venv
17
-
```
18
-
19
-
This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
20
-
development environment of choice. To activate it from the terminal, run:
21
-
```
22
-
source .venv/bin/activate
23
-
pip install -r requirements.txt
24
-
pip install '.[tests]'
25
-
```
26
-
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
27
-
28
-
Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
29
-
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
30
-
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
31
-
should work as you expect.
32
-
33
8
#### Building via Gradle
34
9
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.
35
10
@@ -39,22 +14,14 @@ To build using Gradle, from the Airbyte repository root, run:
39
14
```
40
15
41
16
#### Create credentials
42
-
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/auth0)
17
+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/auth0)
43
18
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_auth0/spec.yaml` file.
44
19
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
45
-
See `integration_tests/sample_config_access-token.json` for a sample config file.
20
+
See `integration_tests/sample_config.json` for a sample config file.
46
21
47
22
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source auth0 test creds`
Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named.
83
-
First install test dependencies into your virtual environment:
84
-
```
85
-
pip install .[tests]
86
-
```
87
-
### Unit Tests
88
-
To run unit tests locally, from the connector directory run:
89
-
```
90
-
python -m pytest unit_tests
91
-
```
92
49
93
-
### Integration Tests
94
-
There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all source connectors) and custom integration tests (which are specific to this connector).
95
-
#### Custom Integration tests
96
-
Place custom tests inside `integration_tests/` folder, then, from the connector root, run
97
-
```
98
-
python -m pytest integration_tests
99
-
```
100
50
#### Acceptance Tests
101
-
Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
51
+
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.
102
52
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.
103
-
To run your integration tests with acceptance tests, from the connector root, run
0 commit comments