Skip to content

Installation

This page explains how to install the NexosAI API SDK in your Python environment.

Prerequisites

  • Python 3.12 or newer
  • Access to the NexosAI API (API key required)

If the SDK is published on PyPI:

pip install nexosapi

If you are installing from source (e.g., cloning the repository):

git clone https://github.com/kamilrybacki/nexos.api.git
cd nexos.api
pip install .

To use the following commands, you need to have task installed. Plkease refer to the Taskfile installation docs for details.

For easier setup and development, use the provided Taskfile for common commands:

  1. Initialize the project and install all dependencies:
task init-project
  1. Install development dependencies only:
task install-dev
  1. Install production dependencies only:
task install-prod
  1. Enable pre-commit hooks:
task enable-pre-commit
  1. Run tests:
task test
  1. Run linters and formatters:
task lint

Create and activate a virtual environment to isolate dependencies:

python -m venv <venv_path>
source <venv_path>/bin/activate

poetry install

Verify Installation

Check that the SDK is installed and importable:

import nexosapi
print(nexosapi.__version__)

Next Steps