Skip to content

Commit 56fcf5e

Browse files
source-canny contribution from pabloescoder (#45588)
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
1 parent f813e93 commit 56fcf5e

File tree

6 files changed

+1794
-0
lines changed

6 files changed

+1794
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Canny
2+
This directory contains the manifest-only connector for `source-canny`.
3+
https://canny.io/
4+
5+
## Documentation reference:
6+
Visit https://developers.canny.io/api-reference for API documentation
7+
8+
## Authentication setup
9+
`source-canny` uses API Key authentication.
10+
Visit https://developers.canny.io/api-reference#authentication for steps to see your API Key.
11+
12+
## Usage
13+
There are multiple ways to use this connector:
14+
- You can use this connector as any other connector in Airbyte Marketplace.
15+
- You can load this connector in `pyairbyte` using `get_source`!
16+
- You can open this connector in Connector Builder, edit it, and publish to your workspaces.
17+
18+
Please refer to the manifest-only connector documentation for more details.
19+
20+
## Local Development
21+
We recommend you use the Connector Builder to edit this connector.
22+
23+
But, if you want to develop this connector locally, you can use the following steps.
24+
25+
### Environment Setup
26+
You will need `airbyte-ci` installed. You can find the documentation [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md).
27+
28+
### Build
29+
This will create a dev image (`source-canny:dev`) that you can use to test the connector locally.
30+
```bash
31+
airbyte-ci connectors --name=source-canny build
32+
```
33+
34+
### Test
35+
This will run the acceptance tests for the connector.
36+
```bash
37+
airbyte-ci connectors --name=source-canny test
38+
```
39+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
2+
# for more information about how to configure these tests
3+
connector_image: airbyte/source-canny:dev
4+
acceptance_tests:
5+
spec:
6+
tests:
7+
- spec_path: "manifest.yaml"
8+
connection:
9+
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
10+
discovery:
11+
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
12+
basic_read:
13+
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
14+
incremental:
15+
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
16+
full_refresh:
17+
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
Loading

0 commit comments

Comments
 (0)