Skip to content

Commit a85de6f

Browse files
source-picqer contribution from btkcodedev (#45159)
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
1 parent c6530c9 commit a85de6f

File tree

6 files changed

+2202
-0
lines changed

6 files changed

+2202
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Picqer
2+
This directory contains the manifest-only connector for `source-picqer`.
3+
4+
## Documentation reference:
5+
Visit `https://picqer.com/en/api` for API documentation
6+
7+
## Authentication setup
8+
Picqer user basic http for its authentication, follow the [API documentation](https://picqer.com/en/api/) and visit settings page to get your api key.
9+
Configure the API key as your username and leave password field as blank
10+
11+
## Usage
12+
There are multiple ways to use this connector:
13+
- You can use this connector as any other connector in Airbyte Marketplace.
14+
- You can load this connector in `pyairbyte` using `get_source`!
15+
- You can open this connector in Connector Builder, edit it, and publish to your workspaces.
16+
17+
Please refer to the manifest-only connector documentation for more details.
18+
19+
## Local Development
20+
We recommend you use the Connector Builder to edit this connector.
21+
22+
But, if you want to develop this connector locally, you can use the following steps.
23+
24+
### Environment Setup
25+
You will need `airbyte-ci` installed. You can find the documentation [here](airbyte-ci).
26+
27+
### Build
28+
This will create a dev image (`source-picqer:dev`) that you can use to test the connector locally.
29+
```bash
30+
airbyte-ci connectors --name=source-picqer build
31+
```
32+
33+
### Test
34+
This will run the acceptance tests for the connector.
35+
```bash
36+
airbyte-ci connectors --name=source-picqer test
37+
```
38+
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-picqer: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)