Constructor.io Python Client
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
5 maintainers
Release files for constructor-io 1.9.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| constructor_io-1.9.1.tar.gz | 13.1 kB | Details |
Release files / constructor_io-1.9.1.tar.gz
| Download URL | constructor_io-1.9.1.tar.gz |
|---|---|
| Size | 13.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
33d7b389c553e34b2508a13499f6e46b12ac2d0e4ed495bef68dac5eaa8d1b23
|
|
BLAKE2b-256 checksum How to use checksums |
487d5af61bf880b61fed27590d3b562ed6698c57006ee7ea1ec91d16eed8c9f6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.25
|
