The FixpointClient wraps the OpenAI API Client. You can call it just like OpenAI API Client. The sdk will intercept calls to certain OpenAI APIs, record input / outputs and forward that information to Fixpoint's api server.
You can view the package on pypi. To install:
pip install fixpoint_sdk
To use the sdk make sure that you have the following variables set in your environment: FIXPOINT_API_KEY and OPENAI_API_KEY.
To create a virtual environment called venv from your terminal run python3 -m venv venv.
source venv/bin/activate
To install the package locally for development:
# in "editable mode" so your install changes as you update the source code:
pip install -e .
# and to install dev dependencies
pip install -e '.[dev]'
If you get an error like:
ERROR: File "setup.py" not found. Directory cannot be installed in editable mode: /home/dbmikus/workspace/github.com/gofixpoint/python-sdk (A "pyproject.toml" file was found, but editable mode currently requires a setup.py based build.)
Try upgrading pip and retrying:
pip install --upgrade pip
pip install -e .
In general, you should not install from the requirements.txt file, instead
following the installation method suggested above.
deactivate
Set up your Githooks via:
git config core.hooksPath githooks/
You can find examples of how to use the API in examples.