PinionAI Python Library

This is the official Python client library for the PinionAI platform. It provides a convenient, asynchronous way to interact with PinionAI agents, manage sessions, and use its various features including AI interactions and gRPC messaging. AI Agent authoring is performed in PinionAI Studio.

Website and Documentation

PinionAI website

PinionAI documentation

Run PinionAI Agent from Github

Installation

From PyPI

This package is available on PyPI and can be installed with pip or uv. We recommend uv for its speed.

With uv

If you don't have uv, you can install it from astral.sh.

# On macOS and Linux
curl -LsSf https://astral.sh/uv/install.sh | sh
#OR
brew install uv

# On Windows
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

Once uv is installed, you can install the pinionai package from PyPI:

uv pip install pinionai

With pip

If you prefer to use pip, you can still install the package with:

pip install pinionai

From GitHub

To install the latest development version directly from the GitHub repository:

pip install git+https://github.com/pinionai/pinionai-package.git

Optional Features

The base install covers the common client and session workflow. Optional integrations are grouped into extras so you can keep the install lean and only pull in the packages you need.

gcp: Google Cloud Storage support (google-cloud-storage)
aws: AWS S3 support (boto3)
openai: Support for OpenAI models (openai)
anthropic: Support for Anthropic models (anthropic)
javascript: Support for running JavaScript snippets (mini-racer)
sendgrid: Support for running SendGrid delivery
twilio: Support for SMS delivery
telnyx: Support for SMS delivery
mcp: FastMCP tool integration (fastmcp)
data: Tabular and CSV helpers (pandas)
postgres: PostgreSQL connector support (psycopg)
google: Google Gemini / Vertex AI support (google-genai)

To install one or more optional features, specify them in brackets. For example, to get support for GCP, AWS, and Google AI:

pip install "pinionai[gcp,aws,google]"

To install all optional features at once, use the all extra:

pip install "pinionai[all]"

Options include:

dev = [ "build", "twine", "ruff", "grpcio-tools", ]
gcp = ["google-cloud-storage"]
aws = ["boto3"]
openai = ["openai"]
anthropic = ["anthropic"]
javascript = ["mini-racer"]
sendgrid = ["sendgrid"]
twilio = ["twilio"]
mcp = ["fastmcp"]
data = ["pandas"]
postgres = ["psycopg[binary,pool]"]
google = ["google-genai>=1.72.0"]
all = [ "pinionai[gcp,aws,openai,anthropic,javascript,twilio,sendgrid,mcp,data,postgres,google]" ]

Adding to Requirements

To add this library to your project's requirements file, you can use the following formats.

For requirements.txt or requirements.in:

# For a specific version from PyPI
pinionai==0.4.1

# With optional features
pinionai[gcp,openai]==0.4.1

# From the main branch on GitHub
git+https://github.com/pinionai/pinionai-package.git@main

Usage

Here's a Github link to a complete, fully functional example of how to use the AsyncPinionAIClient. In the link to our examples, you can run a Streamlit, CLI chat, Slack or Teams. Note: you can run a targeted agent or deploy to accept AIA files to run various agents.

PinionAI Agent on Github

Configuration For Developers

Setting up the environment

To set up a development environment, first create and activate a virtual environment using uv:

# Create a virtual environment named .venv +uv venv
# Activate the virtual environment
# On macOS and Linux
source .venv/bin/activate
# On Windows
.venv\Scripts\activate

Then, install the package in editable mode with its development dependencies:

uv pip install -e .[dev]