Skip to main content

Insightly source connector

This is the repository for the Insightly source connector, written in Python. For information about how to use this connector within Airbyte, see the documentation.

Local development

Prerequisites

  • Python (~=3.9)
  • Poetry (~=1.7) - installation instructions here

Installing the connector

From this connector directory, run:

poetry install --with dev

Create credentials

If you are a community contributor, follow the instructions in the documentation to generate the necessary credentials. Then create a file secrets/config.json conforming to the source_insightly/spec.yaml file. Note that any directory named secrets is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information. See sample_files/sample_config.json for a sample config file.

Locally running the connector

poetry run source-insightly spec
poetry run source-insightly check --config secrets/config.json
poetry run source-insightly discover --config secrets/config.json
poetry run source-insightly read --config secrets/config.json --catalog sample_files/configured_catalog.json

Running unit tests

To run unit tests locally, from the connector directory run:

poetry run pytest unit_tests

Building the docker image

  1. Install airbyte-ci
  2. Run the following command to build the docker image:
airbyte-ci connectors --name=source-insightly build

An image will be available on your host with the tag airbyte/source-insightly:dev.

Running as a docker container

Then run any of the connector commands as follows:

docker run --rm airbyte/source-insightly:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-insightly:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-insightly:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-insightly:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json

Running our CI test suite

You can run our full test suite locally using airbyte-ci:

airbyte-ci connectors --name=source-insightly test

Customizing acceptance Tests

Customize acceptance-test-config.yml file to configure acceptance tests. See Connector Acceptance Tests for more information. If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.

Dependency Management

All of your dependencies should be managed via Poetry. To add a new dependency, run:

poetry add <package-name>

Please commit the changes to pyproject.toml and poetry.lock files.

Publishing a new version of the connector

You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?

  1. Make sure your changes are passing our test suite: airbyte-ci connectors --name=source-insightly test
  2. Bump the connector version (please follow semantic versioning for connectors):
    • bump the dockerImageTag value in in metadata.yaml
    • bump the version value in pyproject.toml
  3. Make sure the metadata.yaml content is up to date.
  4. Make sure the connector documentation and its changelog is up to date (docs/integrations/sources/insightly.md).
  5. Create a Pull Request: use our PR naming conventions.
  6. Pat yourself on the back for being an awesome contributor.
  7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
  8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

Metadata

Release files for airbyte-source-insightly 0.2.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for airbyte-source-insightly 0.2.16
File Size Uploaded Provenance Actions
airbyte_source_insightly-0.2.16.tar.gz 15.0 kB Without provenance Details for airbyte_source_insightly-0.2.16.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for airbyte-source-insightly 0.2.16
File Interpreter ABI Platform Actions
airbyte_source_insightly-0.2.16-py3-none-any.whl Python 3 none any Details for airbyte_source_insightly-0.2.16-py3-none-any.whl

Total release size: 29.6 kB

Release files / airbyte_source_insightly-0.2.16.tar.gz

Download URL airbyte_source_insightly-0.2.16.tar.gz
Size 15.0 kB
Tags Source
SHA-256 checksum
How to use checksums
2a1f36e33cd1b8b51c2669e00c7c9ee036940f8e84142f8b869887bee147b2b8
BLAKE2b-256 checksum
How to use checksums
4ea953c3a75ed790733e0436bc28006065d953c8b1763e15926afc8f0949f1be
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1025-azure

Release files / airbyte_source_insightly-0.2.16-py3-none-any.whl

Download URL airbyte_source_insightly-0.2.16-py3-none-any.whl
Size 14.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d09f09a352122f03e5244526580f61ea3d7eb48a3474f98764cca663536a6214
BLAKE2b-256 checksum
How to use checksums
bf2e946dd3ff1a5edc6a89ad4b6bb7b5143af626ae1aa4386298c318b8b10c21
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.3 CPython/3.10.14 Linux/6.5.0-1025-azure

Security for airbyte-source-insightly 0.2.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page