🎉 New Source: Copper [python cdk] #18848

akashpatl · 2022-11-02T12:22:33Z

What

The following PR adds a Python CDK source for Copper. A upvoted and requested connector by the community

How

Describe the solution
The PR uses the Python CDK and implements full refresh syncs of the following streams:

People
Projects
Companies

🚨 User Impact 🚨

No changes to existing code.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

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
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as 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
- Connector's bootstrap.md. See description and examples
- Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
PR name follows PR naming conventions

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
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub and connector version bumped 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

Tests

Unit

Put your unit tests output here.

Acceptance

Put your acceptance tests output here.

akashpatl · 2022-11-02T12:25:16Z

Link to issue

marcosmarxm

Hello @akashpatl, Marcos from Airbyte here 👋 . We received more than 25 new contributions along the weekend. One is yours 🎉 thank so much for! Our team is limited and maybe the review process can take longer than expected. As described in the Airbyte's Hacktoberfest your contribution was submitted before November 2nd and it is eligible to win the prize. The review process will validate other requirements. I ask to you patience until someone from the team review it.

Because I reviewed some contributions for Hacktoberfest so far I saw some common patterns you can check in advance:

Make sure you have added connector documentation to /docs/integrations/
Remove the file catalog from /integration_tests
Edit the sample_config.json inside /integration_tests
For the configured_catalog you can use only json_schema: {}
Add title to all properties in the spec.yaml
Make sure the documentationUrl in the spec.yaml redirect to Airbyte's future connector page, eg: connector Airtable the documentationUrl: https://docs.airbyte.com/integrations/sources/airtable
Review now new line at EOF (end-of-file) for all files.

If possible send to me a DM in Slack with the tests credentials, this process will make easier to us run integration tests and publish your connector. If you only has production keys, make sure to create a bootstrap.md explaining how to get the keys.

marcosmarxm · 2022-11-04T08:56:20Z

Hello! I'm going to be out of the office this Friday and won't be able to review your contribution again today, I return next Monday. So far, most contributions look solid and are almost done to be approved. As said in Chris' comment all contributions made before 2-November are eligible to receive the prize and have 2 weeks to merge the contributions. But I ensure next week we're going to have your contribution merged. If you have questions about the implementation you can send them in #hacktoberfest-2022 in Airbyte's Slack.

Sorry the inconvenience and see you again next week, thank you so much for your contribution!

jacqueskpoty · 2022-11-07T16:42:55Z

@akashpatl Thanks for your contribution. I will be reviewing your PR and will let you know if any change is needed.

marcosmarxm · 2022-11-14T13:48:41Z

@akashpatl are you still working on this?

akashpatl · 2022-11-16T14:58:48Z

@marcosmarxm No, should I be? Based on @jacqueskpoty comment I was waiting for any additional input or feedback needed in order to approve the PR.

Saw some stuff I had forgotten so fixed that but let me know what to fix and I'll get on it quickly!

marcosmarxm · 2022-11-16T16:08:27Z

@akashpatl can you send test credentials in Slack?

akashpatl · 2022-11-17T08:23:18Z

@akashpatl can you send test credentials in Slack?

@marcosmarxm They were sent on Slack to you on 2nd of November and should still work. Let me know if they don't :)

marcosmarxm

Thanks @akashpatl

marcosmarxm · 2022-11-17T22:14:16Z

/test connector=connectors/source-copper

🕑 connectors/source-copper https://github.com/airbytehq/airbyte/actions/runs/3492427374
✅ connectors/source-copper https://github.com/airbytehq/airbyte/actions/runs/3492427374
Python tests coverage:

Name                        Stmts   Miss  Cover
-----------------------------------------------
source_copper/__init__.py       2      0   100%
source_copper/source.py        57      8    86%
-----------------------------------------------
TOTAL                          59      8    86%
	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          12      4    67%   16-19
	 source_acceptance_test/config.py                       133      3    98%   87, 93, 230
	 source_acceptance_test/conftest.py                     196     97    51%   35, 41-43, 48, 54, 60, 66, 72-74, 80-95, 100, 105-107, 113-115, 121-122, 127-128, 133, 139, 148-157, 163-168, 232, 238, 244-250, 258-263, 271-284, 289-295, 302-313, 320-336
	 source_acceptance_test/plugin.py                        69     25    64%   22-23, 31, 36, 120-140, 144-148
	 source_acceptance_test/tests/test_core.py              329    106    68%   39, 50-58, 63-70, 74-75, 79-80, 164, 202-219, 228-236, 240-245, 251, 284-289, 327-334, 377-379, 382, 447-455, 484-485, 491, 494, 530-540, 553-578
	 source_acceptance_test/tests/test_incremental.py       145     20    86%   21-23, 29-31, 36-43, 48-61, 224
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  77     10    87%   15-16, 24-30, 64, 67
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/config_migration.py        23     23     0%   5-37
	 source_acceptance_test/utils/connector_runner.py       112     50    55%   23-26, 32, 36, 39-68, 71-73, 76-78, 81-83, 86-88, 91-93, 96-114, 148-150
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1479    376    75%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestIncremental.test_two_sequential_reads: This connector does not implement incremental sync
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:51: The previous connector image could not be retrieved.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:229: The previous connector image could not be retrieved.
======================== 24 passed, 3 skipped in 50.74s ========================

marcosmarxm · 2022-11-17T22:29:24Z

/publish connector=connectors/source-copper

🕑 Publishing the following connectors:
connectors/source-copper
https://github.com/airbytehq/airbyte/actions/runs/3492517788

Connector	Did it publish?	Were definitions generated?
connectors/source-copper	✅	✅

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

Akash Patel added 8 commits November 1, 2022 10:00

add younium source along with documentation

1ade9bd

init commit for new python source

e603299

added streams for projects, companies and people

f169352

breakout http_method

2f5dbe5

add docs for Copper

55f9185

docs were not included in previous commit

13c0ba2

indentation error

cbfd3d9

update schemas that failed acceptance test

8c2d883

github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Nov 2, 2022

octavia-squidington-iv added bounty community connectors/source/copper labels Nov 2, 2022

Akash Patel and others added 2 commits November 2, 2022 13:29

resolve merge conflict with docs

0202820

Merge branch 'master' into source/copper-python-cdk

d8cd2c2

marcosmarxm added the hacktober label Nov 2, 2022

marcosmarxm requested changes Nov 2, 2022

View reviewed changes

sajarin added the bounty-XL Maintainer program: claimable extra large bounty PR label Nov 7, 2022

sajarin assigned jacqueskpoty Nov 7, 2022

Akash Patel added 3 commits November 16, 2022 16:02

add title to spec

bf8fc9b

update doc url

0b36dc2

newlines

b93d6af

akashpatl requested a review from marcosmarxm November 16, 2022 15:05

marcosmarxm approved these changes Nov 17, 2022

View reviewed changes

marcosmarxm added 2 commits November 17, 2022 19:13

add copper to source def

3819ba1

add copper to source def

3577a65

marcosmarxm and others added 2 commits November 17, 2022 19:18

run format

daa5fb9

Merge branch 'master' into source/copper-python-cdk

bdc6e36

auto-bump connector version

d801306

marcosmarxm merged commit 5c7affc into airbytehq:master Nov 17, 2022

octavia-squidington-iii mentioned this pull request Nov 18, 2022

Bump Airbyte version from 0.40.18 to 0.40.19 #19579

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🎉 New Source: Copper [python cdk] #18848

🎉 New Source: Copper [python cdk] #18848

akashpatl commented Nov 2, 2022

akashpatl commented Nov 2, 2022

marcosmarxm left a comment

marcosmarxm commented Nov 4, 2022

jacqueskpoty commented Nov 7, 2022

marcosmarxm commented Nov 14, 2022

akashpatl commented Nov 16, 2022 •

edited

marcosmarxm commented Nov 16, 2022

akashpatl commented Nov 17, 2022

marcosmarxm left a comment

marcosmarxm commented Nov 17, 2022 •

edited by github-actions bot

marcosmarxm commented Nov 17, 2022 •

edited by github-actions bot

🎉 New Source: Copper [python cdk] #18848

🎉 New Source: Copper [python cdk] #18848

Conversation

akashpatl commented Nov 2, 2022

What

How

Recommended reading order

🚨 User Impact 🚨

Pre-merge Checklist

Community member or Airbyter

Airbyter

Community member or Airbyter

Airbyter

Tests

akashpatl commented Nov 2, 2022

marcosmarxm left a comment

Choose a reason for hiding this comment

marcosmarxm commented Nov 4, 2022

jacqueskpoty commented Nov 7, 2022

marcosmarxm commented Nov 14, 2022

akashpatl commented Nov 16, 2022 • edited

marcosmarxm commented Nov 16, 2022

akashpatl commented Nov 17, 2022

marcosmarxm left a comment

Choose a reason for hiding this comment

marcosmarxm commented Nov 17, 2022 • edited by github-actions bot

Build Passed

marcosmarxm commented Nov 17, 2022 • edited by github-actions bot

akashpatl commented Nov 16, 2022 •

edited

marcosmarxm commented Nov 17, 2022 •

edited by github-actions bot

marcosmarxm commented Nov 17, 2022 •

edited by github-actions bot