Skip to content

Commit 29ef9a0

Browse files
authored
Source paystack: Migrate to manifest-only (#44101)
1 parent f60e3cb commit 29ef9a0

File tree

13 files changed

+3710
-2934
lines changed

13 files changed

+3710
-2934
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,108 +1,65 @@
11
# Paystack source connector
22

3+
This directory contains the manifest-only connector for `source-paystack`.
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 Paystack configuration based source connector.
5-
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/paystack).
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/paystack).
67

78
## Local development
89

9-
### Prerequisites
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!
1013

11-
* Python (`^3.9`)
12-
* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)
14+
If you prefer to develop locally, you can follow the instructions below.
1315

16+
### Building the docker image
1417

18+
You can build any manifest-only connector with `airbyte-ci`:
1519

16-
### Installing the connector
20+
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
21+
2. Run the following command to build the docker image:
1722

18-
From this connector directory, run:
1923
```bash
20-
poetry install --with dev
24+
airbyte-ci connectors --name=source-paystack build
2125
```
2226

27+
An image will be available on your host with the tag `airbyte/source-paystack:dev`.
2328

24-
### Create credentials
29+
### Creating credentials
2530

2631
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/paystack)
27-
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `spec` inside `source_paystack/mainfest.yaml` file.
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.
2833
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
29-
See `sample_files/sample_config.json` for a sample config file.
30-
31-
32-
### Locally running the connector
33-
```
34-
poetry run source-paystack spec
35-
poetry run source-paystack check --config secrets/config.json
36-
poetry run source-paystack discover --config secrets/config.json
37-
poetry run source-paystack read --config secrets/config.json --catalog integration_tests/configured_catalog.json
38-
```
39-
40-
### Running tests
4134

42-
To run tests locally, from the connector directory run:
43-
44-
```
45-
poetry run pytest tests
46-
```
35+
### Running as a docker container
4736

48-
### Building the docker image
37+
Then run any of the standard source connector commands:
4938

50-
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
51-
2. Run the following command to build the docker image:
5239
```bash
53-
airbyte-ci connectors --name=source-paystack build
54-
```
55-
56-
An image will be available on your host with the tag `airbyte/source-paystack:dev`.
57-
An image will be available on your host with the tag `airbyte/source-paystack:dev`.
58-
59-
60-
### Running as a docker container
61-
62-
Then run any of the connector commands as follows:
63-
```
6440
docker run --rm airbyte/source-paystack:dev spec
6541
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-paystack:dev check --config /secrets/config.json
6642
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-paystack:dev discover --config /secrets/config.json
6743
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-paystack:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
6844
```
6945

70-
### Running our CI test suite
46+
### Running the CI test suite
7147

7248
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
73-
```bash
74-
airbyte-ci connectors --name=source-paystack test
75-
```
76-
77-
### Customizing acceptance Tests
78-
79-
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.
80-
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.
81-
82-
### Dependency Management
8349

84-
All of your dependencies should be managed via Poetry.
85-
To add a new dependency, run:
8650
```bash
87-
poetry add <package-name>
51+
airbyte-ci connectors --name=source-paystack test
8852
```
8953

90-
Please commit the changes to `pyproject.toml` and `poetry.lock` files.
91-
9254
## Publishing a new version of the connector
9355

94-
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
95-
1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-paystack test`
96-
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)):
56+
If you want to contribute changes to `source-paystack`, 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-paystack 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)):
9760
- bump the `dockerImageTag` value in in `metadata.yaml`
98-
- bump the `version` value in `pyproject.toml`
99-
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)):
100-
- bump the `dockerImageTag` value in in `metadata.yaml`
101-
- bump the `version` value in `pyproject.toml`
102-
3. Make sure the `metadata.yaml` content is up to date.
103-
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/paystack.md`).
10461
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/paystack.md`).
10562
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).
10663
6. Pat yourself on the back for being an awesome contributor.
10764
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
108-
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
65+
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

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

-3
This file was deleted.

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ connector_image: airbyte/source-paystack:dev
22
acceptance_tests:
33
spec:
44
tests:
5-
- spec_path: "source_paystack/spec.json"
5+
- spec_path: "manifest.yaml"
66
connection:
77
tests:
88
- config_path: "secrets/config.json"

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

-8
This file was deleted.

0 commit comments

Comments
 (0)