Skip to main content

Constructor.io Python Client

Project description

Constructor.io Python Client

Version License: MIT

A Python client for Constructor.io. Constructor.io provides search as a service that optimizes results using artificial intelligence (including natural language processing, re-ranking to optimize for conversions, and user personalization).

Documentation

Full API documentation is available on Github Pages

Requirements

Requesting results from your back-end can be useful in order to control result rendering logic on your server, or augment/hydrate results with data from another system. However, a back-end integration has additional requirements compared to a front-end integration. Please review the Additional Information For Backend Integrations article within the wiki for more detail.

1. Install

pip install constructor-io

2. Retrieve an API key and token

You can find this in your Constructor.io dashboard. Contact sales if you'd like to sign up, or support if you believe your company already has an account.

3. Implement the Client

Once imported, an instance of the client can be created as follows:

from constructor_io.constructor_io import ConstructorIO

constructorio = ConstructorIO({
    "api_key": "YOUR API KEY",
})

4. Retrieve Results

After instantiating an instance of the client, four modules will be exposed as properties to help retrieve data from Constructor.io: search, browse, autocomplete, and recommendations.

Development

make install                            # install dependencies
pipenv run pylint constructor_io  # run lint
pipenv run pytest .                     # run tests with coverage report
make docs                               # output documentation to `./docs` directory

Project details


Download files

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

Source Distribution

constructor-io-1.8.7.tar.gz (12.0 kB view details)

Uploaded Source

File details

Details for the file constructor-io-1.8.7.tar.gz.

File metadata

  • Download URL: constructor-io-1.8.7.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/8.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.22

File hashes

Hashes for constructor-io-1.8.7.tar.gz
Algorithm Hash digest
SHA256 672dd5a0ce5fae9e0a7aebe9d1717eafbcbf39cbb9e2c9d7f27c6c00b5a8799f
MD5 c79b07d5dd4bb78d1d77f9838882b1b8
BLAKE2b-256 cf5f0ef679ac94ceac6d62c9543fc5fb09411af8ee1436d9767b5c2282bb10b6

See more details on using hashes here.

Supported by

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