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 : Avni #28141

Closed
wants to merge 23 commits into from
Closed

Conversation

avirajsingh7
Copy link
Contributor

@avirajsingh7 avirajsingh7 commented Jul 11, 2023

What

Describe what the change is solving

AVNI is an open source platform for on field service and data collection. A three-level adjustable data structure given by Avni enables modelling of the services offered (or data collected). Setting up topics, enrolling subjects in programmes, and establishing encounters for enrollments/subjects are all possible with Avni.
For organizations using Avni having a native Airbyte connector to import data will allow for ingestion into their data warehouses and use of the data for analysis.

It helps to add screenshots if it affects the frontend.

doesn't effect the frontend

How

Describe the solution

The current version of the connector provides for ingesting data through Airbyte from multiple streams . The implemented version of the connector will allow for all sync modes - full refresh and incremental including de-duped mode.
Avni Api Docs
Avni Api Endpoints

Pre-merge Actions

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)

  • 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.

  • Connector version is set to 0.1.0

    • Dockerfile has version 0.1.0
  • Documentation updated

    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog with an entry for the initial version. See changelog example
    • docs/integrations/README.md

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.
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

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.
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 Test Screenshot 2023-07-11 at 12 28 19 PM
Integration Test Connector: Screenshot 2023-07-11 at 12 54 45 PM
Acceptance Test Screenshot 2023-07-11 at 12 47 24 PM

@CLAassistant
Copy link

CLAassistant commented Jul 11, 2023

CLA assistant check
All committers have signed the CLA.

@octavia-squidington-iii octavia-squidington-iii added area/connectors Connector related issues area/documentation Improvements or additions to documentation community connectors/source/avni labels Jul 11, 2023
@github-actions
Copy link
Contributor

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • PR name follows PR naming conventions
  • Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan and you've followed all steps in the Breaking Changes Checklist
  • Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • Secrets in the connector's spec are annotated with airbyte_secret
  • All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • The connector tests are passing in CI
  • You've updated the connector's metadata.yaml file (new!)
  • If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

@avirajsingh7 avirajsingh7 changed the title New Source Connector : Avni 🎉 New Source : Avni Jul 11, 2023
@marcosmarxm marcosmarxm added the team/tse Technical Support Engineers label Jul 12, 2023
Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments. It would be better to implement this connector using low code connector.

@avirajsingh7
Copy link
Contributor Author

avirajsingh7 commented Jul 26, 2023

@marcosmarxm can you review it now , I have made the changes you suggested.

And Regarding low code we will do it later ....

@avirajsingh7 avirajsingh7 requested a review from a team as a code owner August 1, 2023 10:40
@avirajsingh7 avirajsingh7 requested a review from a team August 1, 2023 10:40
@octavia-squidington-iii octavia-squidington-iii added area/api Related to the api area/platform issues related to the platform CDK Connector Development Kit normalization and removed area/platform issues related to the platform CDK Connector Development Kit area/api Related to the api normalization labels Aug 1, 2023
@marcosmarxm marcosmarxm removed request for a team August 1, 2023 11:55
Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments please take a look.

@siddhant3030 siddhant3030 force-pushed the AvniConnector branch 3 times, most recently from 9a349a1 to d4edf43 Compare August 1, 2023 12:44
@avirajsingh7
Copy link
Contributor Author

@marcosmarxm Done suggested Changes Can you review it now?

@marcosmarxm
Copy link
Member

It looks good @avirajsingh7 can you share the output of integration tests?
./gradlew airbyte-integrations:connectors:source-avni:integrationTest

@avirajsingh7
Copy link
Contributor Author

avirajsingh7 commented Aug 3, 2023

@marcosmarxm
Terminal output : avni_build.txt

Screenshot 2023-08-03 at 7 40 13 PM

@avirajsingh7
Copy link
Contributor Author

@marcosmarxm can you review it?

@marcosmarxm
Copy link
Member

Thanks for sharing the output @avirajsingh7 right now our team is responsible for the August Hackathon and all efforts are directed to review these contributions. After the event is done we're going to return to your contribution.

@marcosmarxm
Copy link
Member

Hello @avirajsingh7 thanks so much for your effort but the project is not accepting Python CDK sources anymore. This is a decision to improve maintenance and support. You can use the version for your project and if you want to contribute we recommend to move the connector to low-code/no-code framework.

Hope you understand the decision,
Bests
Marcos

@marcosmarxm marcosmarxm closed this Sep 4, 2023
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 community connectors/source/avni team/tse Technical Support Engineers
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

4 participants