Skip to main content

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

Github PinionAI Agent Example - reflex/fastapi

Github PinionAI Agent Examples - streamlit, cli, slack, teams

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
  • data: Tabular and CSV helpers (pandas)
  • 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>=3.0.0", "google-cloud-speech"] aws = ["boto3"] openai = ["openai"] anthropic = ["anthropic"] mistral = ["mistralai"] google = ["google-genai"] javascript = ["mini-racer"] sftp = ["paramiko"] sendgrid = ["sendgrid"] twilio = ["twilio"] data = ["pandas"] telemetry = [ "opentelemetry-api>=1.45,<2", "opentelemetry-sdk>=1.45,<2", "opentelemetry-exporter-otlp>=1.45,<2", ] all = [ "pinionai[gcp,aws,sftp,openai,anthropic,mistral,javascript,twilio,sendgrid,data,google,telemetry]", ]

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.9

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

# 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]

Metadata

Release files for pinionai 0.5.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pinionai 0.5.2
File Size Uploaded Provenance Actions
pinionai-0.5.2.tar.gz 113.6 kB Without provenance Details for pinionai-0.5.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pinionai 0.5.2
File Interpreter ABI Platform Actions
pinionai-0.5.2-py3-none-any.whl Python 3 none any Details for pinionai-0.5.2-py3-none-any.whl

Total release size: 227.7 kB

Release files / pinionai-0.5.2.tar.gz

Download URL pinionai-0.5.2.tar.gz
Size 113.6 kB
Tags Source
SHA-256 checksum
How to use checksums
c64855f5c0f9dd7627d0e5d7d7869e6e235fd3020710162b6705739c32afbaf8
BLAKE2b-256 checksum
How to use checksums
e0a73820b5e23c4ee31e125376cad5073fd6f58e74c887be79981d76961e31af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.0

Release files / pinionai-0.5.2-py3-none-any.whl

Download URL pinionai-0.5.2-py3-none-any.whl
Size 114.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2dbd7a7021ca7e4ccadbc81f6e0f0dc22eaff08605bb8fb812e012ad73dae794
BLAKE2b-256 checksum
How to use checksums
d8f39b73945e16a2863a4506c408c8f98834bae26b2ad2065d999ef44b4c9415
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.0

Security for pinionai 0.5.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.5.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page