Skip to main content

Source implementation for HubSpot.

Project description

Hubspot source connector

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

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

Running as a docker container

Then run any of the connector commands as follows:

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file airbyte_source_hubspot-4.0.0.dev202402272131.tar.gz.

File metadata

File hashes

Hashes for airbyte_source_hubspot-4.0.0.dev202402272131.tar.gz
Algorithm Hash digest
SHA256 081ced57ed34d0edc7056d99ae44a7ed332ab30bc726d6eeb3e538baafb2b3c9
MD5 56b3a503a1481be96970a5680579442d
BLAKE2b-256 e12dfc73afa1f71e8178a824eb96131a18ac64f4d92b115a3193b7440f727c1f

See more details on using hashes here.

File details

Details for the file airbyte_source_hubspot-4.0.0.dev202402272131-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_source_hubspot-4.0.0.dev202402272131-py3-none-any.whl
Algorithm Hash digest
SHA256 554341d24aea1fb5639c073c70ff2a665a306e786d2d1c51caea5a4dc7c425b0
MD5 c60b656e6509a49ce2730d4fe8dc7d4a
BLAKE2b-256 f0ce18102142ceaf228451145813eea0250ff5e3ae3fbacc6db7ec20461362dd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page