Package: airbyte-source-recurly
Recurly source connectorThis is the repository for the Recurly source connector, written in Python.
For information about how to use this connector within Airbyte, seethe documentation.Local developmentPrerequisitesPython (~=3.9)Poetry (~=1.7) - installation instructionshereInstalling the connectorFrom this connector directory, run:poetryinstall--withdevCreating credentialsIf you are a community contributor, follow the instructions in thedocumentationto generate the necessary credentials. Then create a filesecrets/config.jsonconforming to thesource_recurly/spec.jsonfile.
Note that thesecretsdirectory is gitignored by default, so there is no danger of accidentally checking in sensitive information.
Seeintegration_tests/sample_config.jsonfor a sample config file.If you are an Airbyte core member, copy the credentials in Lastpass under the secret namesource recurly test credsand place them intosecrets/config.json.Locally running the connectorpoetryrunsource-recurlyspec
poetryrunsource-recurlycheck--configsecrets/config.json
poetryrunsource-recurlydiscover--configsecrets/config.json
poetryrunsource-recurlyread--configsecrets/config.json--catalogsample_files/configured_catalog.jsonRunning unit testsTo run unit tests locally, from the connector directory run:poetryrunpytestunit_testsBuilding the docker imageInstallairbyte-ciRun the following command to build the docker image:airbyte-ciconnectors--name=source-recurlybuildAn image will be available on your host with the tagairbyte/source-recurly:dev.Running the docker containerThen run any of the connector commands as follows:dockerrun--rmairbyte/source-recurly:devspec
dockerrun--rm-v$(pwd)/secrets:/secretsairbyte/source-recurly:devcheck--config/secrets/config.json
dockerrun--rm-v$(pwd)/secrets:/secretsairbyte/source-recurly:devdiscover--config/secrets/config.json
dockerrun--rm-v$(pwd)/secrets:/secrets-v$(pwd)/integration_tests:/integration_testsairbyte/source-recurly:devread--config/secrets/config.json--catalog/integration_tests/configured_catalog.jsonRunning our CI test suiteYou can run our full test suite locally usingairbyte-ci:airbyte-ciconnectors--name=source-recurlytestCustomizing acceptance TestsCustomize theacceptance-test-config.ymlfile to configure acceptance tests. See ourConnector Acceptance Tests referencefor more information.
If your connector requires you to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.Dependency ManagementAll of your dependencies should be managed via Poetry. To add a new dependency, run:poetryadd<package-name>Please commit the changes to thepyproject.tomlandpoetry.lockfiles.Publishing a new version of the connectorYou've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?Make sure your changes are passing our test suite:airbyte-ci connectors --name=source-recurly testBump the connector version listed asdockerImageTaginmetadata.yaml. Please followsemantic versioning for connectors.Make sure themetadata.yamlcontent is up to date.Make the connector documentation and its changelog is up to date (docs/integrations/sources/recurly.md).Create a Pull Request: useour PR naming conventions.Pat yourself on the back for being an awesome contributor.Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.