-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
source-shippo contribution from aazam-gh (#47485)
Co-authored-by: Marcos Marx <[email protected]>
- Loading branch information
1 parent
43055d5
commit c25f3fc
Showing
6 changed files
with
1,872 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Shippo | ||
This directory contains the manifest-only connector for `source-shippo`. | ||
|
||
This is the Shippo source for ingesting data using the Shippo API. | ||
|
||
Shippo is your one-stop solution for shipping labels. Whether you use our app to ship or API to power your logistics workflow, Shippo gives you scalable shipping tools, the best rates, and world-class support https://goshippo.com/ | ||
|
||
In order to use this source, you must first create a Shippo account. Once logged in, head over to Settings -> Advanced -> API and click on generate new token. You can learn more about the API here https://docs.goshippo.com/shippoapi/public-api/#tag/Overview | ||
|
||
## 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-shippo:dev`) that you can use to test the connector locally. | ||
```bash | ||
airbyte-ci connectors --name=source-shippo build | ||
``` | ||
|
||
### Test | ||
This will run the acceptance tests for the connector. | ||
```bash | ||
airbyte-ci connectors --name=source-shippo test | ||
``` | ||
|
17 changes: 17 additions & 0 deletions
17
airbyte-integrations/connectors/source-shippo/acceptance-test-config.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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-shippo: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" |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.