Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🎉 New source connector bigcommerce #5521

Merged
merged 7 commits into from
Aug 28, 2021
Merged

🎉 New source connector bigcommerce #5521

merged 7 commits into from
Aug 28, 2021

Conversation

jacqueskpoty
Copy link
Contributor

@jacqueskpoty jacqueskpoty commented Aug 19, 2021

What

As an Air-byte user, I needed to pull data from bigcommerce. Being that air-byte has no bigcommerce source available now, I need to develop a source that supports data pulling from bigcommerce.

How

I built a bigcommerce source with the airbyte python CDK

Recommended reading order

  1. x.java
  2. y.python

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions
  • Connector added to connector index like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions
  • Connector version bumped like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Aug 19, 2021
@jacqueskpoty
Copy link
Contributor Author

Screen Shot 2021-08-18 at 2 59 53 PM

@marcosmarxm
Copy link
Member

Thanks for the contribution @jacqueskpoty we're going to review this later today.

@marcosmarxm marcosmarxm requested review from Phlair and tuliren and removed request for Phlair August 25, 2021 18:28
@marcosmarxm marcosmarxm assigned tuliren and unassigned Phlair Aug 26, 2021
@tuliren
Copy link
Contributor

tuliren commented Aug 28, 2021

@jacqueskpoty this is great! I found one issue that calling the API with invalid_config.json results in exception. Not sure why it did not show up when you tested it. If I change the start_date to a valid date, it works. Something like this:

{
  "start_date": "2020-01-01",
  "store_hash": "STORE_HASH",
  "access_token": "ACCESS_TOKEN"
}

There are a few other minor issues (e.g. unused import). I will merge it as is, and create another PR to fix those issues and publish it.

Thank you for your contribution!

@tuliren tuliren merged commit 4e8f7af into airbytehq:master Aug 28, 2021
@tuliren tuliren mentioned this pull request Aug 28, 2021
17 tasks
@jacqueskpoty jacqueskpoty deleted the New_Source_Connector_BigCommerce branch August 29, 2021 06:47
@avaidyanatha avaidyanatha changed the title New source connector bigcommerce 🎉 New source connector bigcommerce Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation connectors/source/bigcommerce connectors/sources-api
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants