Skip to content

Commit 60b7ba2

Browse files
authored
Source toggl: Migrate to manifest-only (#44056)
1 parent 2fab479 commit 60b7ba2

File tree

13 files changed

+1412
-2075
lines changed

13 files changed

+1412
-2075
lines changed

airbyte-integrations/connectors/source-toggl/README.md

+27-53
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,63 @@
11
# Toggl source connector
22

3+
This directory contains the manifest-only connector for `source-toggl`.
4+
This _manifest-only_ connector is not a Python package on its own, as it runs inside of the base `source-declarative-manifest` image.
35

4-
This is the repository for the Toggl source connector, written in Python.
5-
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/toggl).
6+
For information about how to configure and use this connector within Airbyte, see [the connector's full documentation](https://docs.airbyte.com/integrations/sources/toggl).
67

78
## Local development
89

9-
### Prerequisites
10-
* Python (~=3.9)
11-
* Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
10+
We recommend using the Connector Builder to edit this connector.
11+
Using either Airbyte Cloud or your local Airbyte OSS instance, navigate to the **Builder** tab and select **Import a YAML**.
12+
Then select the connector's `manifest.yaml` file to load the connector into the Builder. You're now ready to make changes to the connector!
1213

14+
If you prefer to develop locally, you can follow the instructions below.
1315

14-
### Installing the connector
15-
From this connector directory, run:
16-
```bash
17-
poetry install --with dev
18-
```
19-
20-
21-
### Create credentials
22-
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/toggl)
23-
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_toggl/spec.yaml` file.
24-
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
25-
See `integration_tests/sample_config.json` for a sample config file.
26-
27-
28-
### Locally running the connector
29-
```
30-
poetry run source-toggl spec
31-
poetry run source-toggl check --config secrets/config.json
32-
poetry run source-toggl discover --config secrets/config.json
33-
poetry run source-toggl read --config secrets/config.json --catalog sample_files/configured_catalog.json
34-
```
16+
### Building the docker image
3517

36-
### Running unit tests
37-
To run unit tests locally, from the connector directory run:
38-
```
39-
poetry run pytest unit_tests
40-
```
18+
You can build any manifest-only connector with `airbyte-ci`:
4119

42-
### Building the docker image
4320
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
4421
2. Run the following command to build the docker image:
22+
4523
```bash
4624
airbyte-ci connectors --name=source-toggl build
4725
```
4826

4927
An image will be available on your host with the tag `airbyte/source-toggl:dev`.
5028

29+
### Creating credentials
30+
31+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/toggl)
32+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` object in the connector's `manifest.yaml` file.
33+
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
5134

5235
### Running as a docker container
53-
Then run any of the connector commands as follows:
54-
```
36+
37+
Then run any of the standard source connector commands:
38+
39+
```bash
5540
docker run --rm airbyte/source-toggl:dev spec
5641
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-toggl:dev check --config /secrets/config.json
5742
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-toggl:dev discover --config /secrets/config.json
5843
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-toggl:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
5944
```
6045

61-
### Running our CI test suite
62-
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
63-
```bash
64-
airbyte-ci connectors --name=source-toggl test
65-
```
46+
### Running the CI test suite
6647

67-
### Customizing acceptance Tests
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.
69-
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.
48+
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
7049

71-
### Dependency Management
72-
All of your dependencies should be managed via Poetry.
73-
To add a new dependency, run:
7450
```bash
75-
poetry add <package-name>
51+
airbyte-ci connectors --name=source-toggl test
7652
```
7753

78-
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
79-
8054
## Publishing a new version of the connector
81-
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
82-
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-toggl test`
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)):
55+
56+
If you want to contribute changes to `source-toggl`, here's how you can do that:
57+
1. Make your changes locally, or load the connector's manifest into Connector Builder and make changes there.
58+
2. Make sure your changes are passing our test suite with `airbyte-ci connectors --name=source-toggl test`
59+
3. 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)):
8460
- bump the `dockerImageTag` value in in `metadata.yaml`
85-
- bump the `version` value in `pyproject.toml`
86-
3. Make sure the `metadata.yaml` content is up to date.
8761
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/toggl.md`).
8862
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).
8963
6. Pat yourself on the back for being an awesome contributor.

airbyte-integrations/connectors/source-toggl/__init__.py

-3
This file was deleted.

airbyte-integrations/connectors/source-toggl/acceptance-test-config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ connector_image: airbyte/source-toggl:dev
44
acceptance_tests:
55
spec:
66
tests:
7-
- spec_path: "source_toggl/spec.yaml"
7+
- spec_path: "manifest.yaml"
88
connection:
99
tests:
1010
- config_path: "secrets/config.json"

airbyte-integrations/connectors/source-toggl/main.py

-8
This file was deleted.

0 commit comments

Comments
 (0)