Getting started

What is Python Virtual Environment and how do I set it up for my project?

A Python virtual environment is a self-contained directory that houses a specific Python interpreter and all the libraries required for a particular project. It allows you to isolate your project’s dependencies, ensuring a clean and organized development environment. Using virtual environments is recommended to avoid conflicts between projects and maintain better control over your Python packages.

For detailed instructions on setting up a Python Virtual Environment for your project, visit our documentation page on Setting Up a Python Virtual Environment. It will walk you through the process of creating a virtual environment, and activating or deactivating it.

How do I install the Peak SDK and CLI?

To install the Peak SDK and CLI, you can visit our documentation page on SDK and CLI Installation.

I am facing issues with Peak SDK installation even though I am within a virtual environment. How can I resolve these installation problems?

If you encounter problems while installing the Peak SDK within your virtual environment, it’s possible that the peak-sdk package is installed outside of the virtual environment. This can lead to package dependency conflicts and affect the SDK’s functionality.

To resolve this, you should first go outside of your virtual environment and then run pip uninstall peak-sdk command. After uninstalling the peak-sdk globally, activate your desired virtual environment and follow the installation process as mentioned in our installation guide.

How do I obtain an API key to use the Peak SDK and CLI?

To start using the SDK and CLI, you’ll need to obtain an API key by signing up for an account on our platform. After obtaining your API key, export it to your local environment using the following command:

export API_KEY=<api_key>

Where can I find sample code and examples to learn how to use the Peak SDK and CLI?

To effectively interact with the Peak SDK and CLI, explore the following sections in our documentation:

  • SDK Usages: The SDK Usages section contains sample code and examples that demonstrate various use cases and functionalities of the Peak SDK.

  • CLI Usages: In the CLI Usages section, you’ll find practical examples and explanations on how to utilize the CLI and its commands.

Where can I find references for the available functions in the Peak SDK and commands in the CLI?

For detailed information about the functions provided by the Peak SDK and the available commands in the CLI, refer to the following sections in our documentation:

  • SDK Reference: The SDK reference section provides comprehensive documentation on all the functions, methods, and classes available in the Peak SDK.

  • CLI Reference: The CLI Reference section offers an exhaustive list of all the commands and options available in the CLI.