Skip to content

Commit

Permalink
Source Persistiq: Chenged last records to last record (#37596)
Browse files Browse the repository at this point in the history
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
  • Loading branch information
lazebnyi and octavia-squidington-iii committed May 14, 2024
1 parent a4141f5 commit f5f9fc0
Show file tree
Hide file tree
Showing 12 changed files with 1,479 additions and 1,124 deletions.
38 changes: 0 additions & 38 deletions airbyte-integrations/connectors/source-persistiq/Dockerfile

This file was deleted.

76 changes: 51 additions & 25 deletions airbyte-integrations/connectors/source-persistiq/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,59 @@
# Persistiq Source
# Persistiq source connector

This is the repository for the Persistiq configuration based source connector.
This is the repository for the Persistiq source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/persistiq).

## Local development

#### Create credentials
### Prerequisites

- Python (~=3.9)
- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)

### Installing the connector

From this connector directory, run:

```bash
poetry install --with dev
```

### Create credentials

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/persistiq)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_persistiq/spec.yaml` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
See `integration_tests/sample_config.json` for a sample config file.
See `sample_files/sample_config.json` for a sample config file.

**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source persistiq test creds`
and place them into `secrets/config.json`.
### Locally running the connector

### Locally running the connector docker image
```
poetry run source-persistiq spec
poetry run source-persistiq check --config secrets/config.json
poetry run source-persistiq discover --config secrets/config.json
poetry run source-persistiq read --config secrets/config.json --catalog sample_files/configured_catalog.json
```

#### Build
### Running unit tests

**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
To run unit tests locally, from the connector directory run:

```bash
airbyte-ci connectors --name=source-persistiq build
```
poetry run pytest unit_tests
```

An image will be built with the tag `airbyte/source-persistiq:dev`.
### Building the docker image

**Via `docker build`:**
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
2. Run the following command to build the docker image:

```bash
docker build -t airbyte/source-persistiq:dev .
airbyte-ci connectors --name=source-persistiq build
```

#### Run
An image will be available on your host with the tag `airbyte/source-persistiq:dev`.

### Running as a docker container

Then run any of the connector commands as follows:

Expand All @@ -44,7 +64,7 @@ docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-persistiq:dev discover
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-persistiq:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```

## Testing
### Running our CI test suite

You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):

Expand All @@ -54,25 +74,31 @@ airbyte-ci connectors --name=source-persistiq test

### Customizing acceptance Tests

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.
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.
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.

## Dependency Management
### Dependency Management

All of your dependencies should be managed via Poetry.
To add a new dependency, run:

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.
We split dependencies between two groups, dependencies that are:
```bash
poetry add <package-name>
```

- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
- required for the testing need to go to `TEST_REQUIREMENTS` list
Please commit the changes to `pyproject.toml` and `poetry.lock` files.

### Publishing a new version of the connector
## Publishing a new version of the connector

You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?

1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-persistiq test`
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).
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)):
- bump the `dockerImageTag` value in `metadata.yaml`
- bump the `version` value in `pyproject.toml`
3. Make sure the `metadata.yaml` content is up to date.
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/persistiq.md`).
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/persistiq.md`).
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).
6. Pat yourself on the back for being an awesome contributor.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ data:
allowedHosts:
hosts:
- api.persistiq.com
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
remoteRegistries:
pypi:
enabled: true
Expand All @@ -14,7 +16,7 @@ data:
connectorSubtype: api
connectorType: source
definitionId: 3052c77e-8b91-47e2-97a0-a29a22794b4b
dockerImageTag: 0.2.0
dockerImageTag: 0.2.1
dockerRepository: airbyte/source-persistiq
githubIssueLabel: source-persistiq
icon: persistiq.svg
Expand Down
Loading

0 comments on commit f5f9fc0

Please sign in to comment.