Skip to content

Commit

Permalink
source-kisi contribution from aazam-gh (#46987)
Browse files Browse the repository at this point in the history
Co-authored-by: Marcos Marx <[email protected]>
  • Loading branch information
aazam-gh and marcosmarxm authored Oct 25, 2024
1 parent 89a1283 commit d15c139
Show file tree
Hide file tree
Showing 6 changed files with 1,703 additions and 0 deletions.
50 changes: 50 additions & 0 deletions airbyte-integrations/connectors/source-kisi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Kisi
This directory contains the manifest-only connector for `source-kisi`.

This is the setup for the Kisi source connector that ingests data from the Kisi API.

Kisi&#39;s sturdy hardware and user-friendly software work in perfect harmony to enhance the security of your spaces. Remotely manage your locations, streamline operations, and stay compliant while enjoying mobile unlocks. https://www.getkisi.com/

In order to use this source, you must first create an account with Kisi.
On the top right corner, click on your name and click on My Account.
Next, select the API tab and click on Add API key. Enter your name, your Kisi password, and your verification code and click Add. Copy the API key shown on the screen.

You can learn more about the API key here https://api.kisi.io/docs#/


Kisi&#39;s sturdy hardware and user-friendly software work in perfect harmony to enhance the security of your spaces. Remotely manage your locations, streamline operations, and stay compliant while enjoying mobile unlocks. https://www.getkisi.com/

In order to use this source, you must first create an account with Kisi.
On the top right corner, click on your name and click on My Account.
Next, select the API tab and click on Add API key. Enter your name, your Kisi password, and your verification code and click Add. Copy the API key shown on the screen.

You can learn more about the API key here https://api.kisi.io/docs#/

## Usage
There are multiple ways to use this connector:
- You can use this connector as any other connector in Airbyte Marketplace.
- You can load this connector in `pyairbyte` using `get_source`!
- You can open this connector in Connector Builder, edit it, and publish to your workspaces.

Please refer to the manifest-only connector documentation for more details.

## Local Development
We recommend you use the Connector Builder to edit this connector.

But, if you want to develop this connector locally, you can use the following steps.

### Environment Setup
You will need `airbyte-ci` installed. You can find the documentation [here](airbyte-ci).

### Build
This will create a dev image (`source-kisi:dev`) that you can use to test the connector locally.
```bash
airbyte-ci connectors --name=source-kisi build
```

### Test
This will run the acceptance tests for the connector.
```bash
airbyte-ci connectors --name=source-kisi test
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 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-kisi:dev
acceptance_tests:
spec:
tests:
- spec_path: "manifest.yaml"
connection:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
discovery:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
basic_read:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
incremental:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
full_refresh:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
5 changes: 5 additions & 0 deletions airbyte-integrations/connectors/source-kisi/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit d15c139

Please sign in to comment.