This Python client will give you access to the Analyzr API. See files in the examples
folder
for examples showing how to use the client. Note that a client_id
should always be provided when querying the API; it is used for reporting purposes.
- For general information please see https://analyzr.ai.
- For help and support see https://help.analyzr.ai.
- For SDK reference documentation see https://analyzr-sdk-python.readthedocs.io.
Getting the client set up will require the following:
- Install the latest version of the client on your local machine:
pip install analyzr-sdk-python
-
Get an API username and password from your Analyzr admin (you may need SSO credentials from your local admin instead).
-
Confirm you are able to connect to the API, and check the API version as follows from a Python session:
>>> from analyzrclient import Analyzer
>>> analyzer = Analyzer(host="<your host>")
>>> analyzer.login()
Login successful
>>> Analyzer().version()
{'status': 200, 'response': {'version': 'x.x.xxx', 'tenant': <your tenant name>, 'copyright': '2024 (c) Go2Market Insights Inc. All rights reserved.'}}
If you are developing the SDK and would like to test the repo, clone it locally using git then run the following from the root directory:
python -m unittest tests.test_all -v # all tests
python -m unittest tests.test_quick -v # quick tests
Make sure you update the config.json
file first to include the name of your API tenant.
To run a single test case do:
python -m unittest tests.test_all.PropensityTest.test_logistic_regression_classifier -v