https://github.com/constructor-io/constructorio-python

Python client for the Constructor.io API
https://github.com/constructor-io/constructorio-python

autocomplete constructorio constructorio-integrations http python rest-client search

Last synced: 7 months ago
JSON representation

Python client for the Constructor.io API

• Host: GitHub
• URL: https://github.com/constructor-io/constructorio-python
• Owner: Constructor-io
• License: mit
• Created: 2015-09-22T21:14:22.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2025-01-13T19:04:08.000Z (12 months ago)
• Last Synced: 2025-06-05T13:05:41.864Z (7 months ago)
• Topics: autocomplete, constructorio, constructorio-integrations, http, python, rest-client, search
• Language: Python
• Homepage:
• Size: 4.08 MB
• Stars: 7
• Watchers: 35
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Constructor.io Python Client

[![Version](https://img.shields.io/pypi/v/constructor-io.svg)](https://pypi.python.org/pypi/constructor-io)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

A Python client for [Constructor.io](http://constructor.io/). [Constructor.io](http://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](https://constructor-io.github.io/constructorio-python)

## 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](https://github.com/Constructor-io/constructorio-python/wiki/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](https://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:

```python

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

```bash

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

```