hubspot-api

This hubspot api is a handy wrapper on top of the existing hubspot python api.

More details around the inner workings of that and the wider Hubspot API can be found there.

Installation

To install the package, run via pip:

pip install git+https://github.com/mannum/hubspot-api.git@1.2.3

Be sure to specify the correct version you want to install.

Quickstart

Initialise Hubspot Client

To create a hubspot client object that can then interact with the Hubspot API, you will first have to create an access_token which can be done via the creation of a private app in Hubspot.

Create a .env file with your HUBSPOT_ACCESS_TOKEN and HUBSPOT_PIPELINE_ID.
DO NOT assign these in your code.
The variables inside the .env file will be passed as environmental variables via the module hs_api.settings.settings

HUBSPOT_ACCESS_TOKEN = 'my_access_token'
HUBSPOT_PIPELINE_ID = 'my_pipeline_id'

You can then define a new client for hubspot by using the following code

from hs_api.api.hubspot_api import HubSpotClient

client = HubSpotClient()

More details on how to use the client can be found in the test cases that demonstrate how the api should work.

Developing

To develop on this hubspot package, you can simple clone the repo and make the dev changes you require. From there you can run tests...

make test

... run linting...

make py-format-lint

... or everything

make all

Releasing

In order to release your changes, you will create a PR for your branch as normal, which will kick off the github actions to run the linting and tests.

Be aware that a couple of the tests can be flakey due to the delay in the asynchronous way hubspot returns results and actually applies them to the underlying data. There are dealys in place to account for this but there can be cases where a test fails because a record appears to have not been created. This probably needs reworking, but feel free to re-run the tests.

When releasing a change, you will have to update the setup.py file with the new version number so that the relevant library imports can get the right version.

Once the PR is approved and tests pass, you can merge back into master.

From here - in Github - you can create a new release, which you can find on the right hand side of the repo page under the About section.

Click on Draft a new release and create a new tag for the version number you used in the setup.py of the merged branch and give it a title and description of the change. This doesn't have to be too formal as this is only internal use at the moment. Now you can click Publish release and this will make it available as a library.

Be sure to update the relevant dependant projects to pull this new version, i.e.

pip install git+https://github.com/mannum/hubspot-api.git@9.9.0