Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

Salesforce source connector

This is the repository for the Salesforce 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_salesforce/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-salesforce spec
poetry run source-salesforce check --config secrets/config.json
poetry run source-salesforce discover --config secrets/config.json
poetry run source-salesforce 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-salesforce build

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

Running as a docker container

Then run any of the connector commands as follows:

docker run --rm airbyte/source-salesforce:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-salesforce:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-salesforce:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-salesforce: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-salesforce 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-salesforce 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/salesforce.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-salesforce 2.4.0.dev202403262029

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-salesforce 2.4.0.dev202403262029
File Size Uploaded Provenance Actions
airbyte_source_salesforce-2.4.0.dev202403262029.tar.gz 26.8 kB Without provenance Details for airbyte_source_salesforce-2.4.0.dev202403262029.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for airbyte-source-salesforce 2.4.0.dev202403262029
File Interpreter ABI Platform Actions
airbyte_source_salesforce-2.4.0.dev202403262029-py3-none-any.whl Python 3 none any Details for airbyte_source_salesforce-2.4.0.dev202403262029-py3-none-any.whl

Total release size: 56.7 kB

Release files / airbyte_source_salesforce-2.4.0.dev202403262029.tar.gz

Download URL airbyte_source_salesforce-2.4.0.dev202403262029.tar.gz
Size 26.8 kB
Tags Source
SHA-256 checksum
How to use checksums
f550a28c7d06b81f1d848680008b2b3d7bd2e207356eca568c095f8b6e117df8
BLAKE2b-256 checksum
How to use checksums
76e4973d0763ea6908757fa7533a70ec66de099999cb1e36a28c8ba20b1e1c11
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.10.14 Linux/6.5.0-1016-azure

Release files / airbyte_source_salesforce-2.4.0.dev202403262029-py3-none-any.whl

Download URL airbyte_source_salesforce-2.4.0.dev202403262029-py3-none-any.whl
Size 29.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
aefa3dd734d6f732a495c3bdb3f3d7eeaf28451fa18a8e82343995e8c72ed4fd
BLAKE2b-256 checksum
How to use checksums
30b89c6c01b0e82742aa133bba64bac7898c9f5afbfcdfb91e4cac815e85b6ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.2 CPython/3.10.14 Linux/6.5.0-1016-azure

Security for airbyte-source-salesforce 2.4.0.dev202403262029

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.

Release history Release notifications | RSS feed

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