Skip to content

Commit

Permalink
🎉 New Source: Northpass LMS (#43319)
Browse files Browse the repository at this point in the history
Co-authored-by: Natik Gadzhi <[email protected]>
  • Loading branch information
sajarin and natikgadzhi authored Aug 7, 2024
1 parent 4d7eed2 commit 223717a
Show file tree
Hide file tree
Showing 15 changed files with 2,528 additions and 0 deletions.
96 changes: 96 additions & 0 deletions airbyte-integrations/connectors/source-northpass-lms/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
# Northpass Lms Source

This is the repository for the Northpass Lms configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/northpass-lms).

## Local development

### Prerequisites

- Python (`^3.10`)
- 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/northpass-lms)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_northpass_lms/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 `sample_files/sample_config.json` for a sample config file.

### Locally running the connector

```
poetry run source-northpass-lms spec
poetry run source-northpass-lms check --config secrets/config.json
poetry run source-northpass-lms discover --config secrets/config.json
poetry run source-northpass-lms read --config secrets/config.json --catalog sample_files/configured_catalog.json
```

### Building the docker image

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
airbyte-ci connectors --name=source-northpass-lms build
```

An image will be available on your host with the tag `airbyte/source-northpass-lms:dev`.

### Running as a docker container

Then run any of the connector commands as follows:

```
docker run --rm airbyte/source-northpass-lms:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-northpass-lms:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-northpass-lms:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-northpass-lms:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```

### 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):

```bash
airbyte-ci connectors --name=source-northpass-lms test
```

### Customizing acceptance Tests

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

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

```bash
poetry add <package-name>
```

Please commit the changes to `pyproject.toml` and `poetry.lock` files.

## 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-northpass-lms test`
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 in `metadata.yaml`
- bump the `version` value in `pyproject.toml`
3. Make sure the `metadata.yaml` content is up to date.
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/northpass-lms.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
@@ -0,0 +1,27 @@
# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
# for more information about how to configure these tests
connector_image: airbyte/source-northpass-lms:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_northpass_lms/manifest.yaml"
connection:
tests:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
tests:
- config_path: "secrets/config.json"
basic_read:
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
incremental:
bypass_reason: "This connector does not implement incremental sync"
full_refresh:
tests:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"streams": [
{
"stream": {
"name": "people",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "courses",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "course_enrollments",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"api_key": "this-api-key-shouldn't-work"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"api_key": "your-api-key"
}
8 changes: 8 additions & 0 deletions airbyte-integrations/connectors/source-northpass-lms/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#
# Copyright (c) 2024 Airbyte, Inc., all rights reserved.
#

from source_northpass_lms.run import run

if __name__ == "__main__":
run()
35 changes: 35 additions & 0 deletions airbyte-integrations/connectors/source-northpass-lms/metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
data:
allowedHosts:
hosts:
- api.northpass.com
registries:
oss:
enabled: true
cloud:
enabled: true
remoteRegistries:
pypi:
enabled: true
packageName: airbyte-source-northpass-lms
connectorBuildOptions:
# Please update to the latest version of the connector base image.
# https://hub.docker.com/r/airbyte/python-connector-base
# Please use the full address with sha256 hash to guarantee build reproducibility.
baseImage: docker.io/airbyte/python-connector-base:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916
connectorSubtype: api
connectorType: source
definitionId: dd4d317e-7537-456c-b6ba-264b17ce6daa
dockerImageTag: 0.1.0
dockerRepository: airbyte/source-northpass-lms
githubIssueLabel: source-northpass-lms
icon: icon.svg
license: MIT
name: Northpass LMS
releaseDate: 2024-08-06
releaseStage: alpha
supportLevel: community
documentationUrl: https://docs.airbyte.com/integrations/sources/northpass-lms
tags:
- language:python
- cdk:low-code
metadataSpecVersion: "1.0"
Loading

0 comments on commit 223717a

Please sign in to comment.