Skip to content

Installation

From PyPI

pip install askritaSuccessfully installed askrita-0.13.9

With Optional Dependencies

pip install askrita[exports]Successfully installed askrita-0.13.9 python-pptx-1.0.2 reportlab-4.4.10 matplotlib-3.10.8 xlsxwriter-3.2.9

From a Private Registry

If your organization hosts Ask RITA on a private package registry, use --extra-index-url:

pip install --extra-index-url https://${REGISTRY_USER}:${REGISTRY_TOKEN}@your-registry.example.com/simple/ askrita

Persistent Configuration (for multiple projects): 

pip config set global.extra-index-url https://${REGISTRY_USER}:${REGISTRY_TOKEN}@your-registry.example.com/simple/
pip install askrita

Secure Authentication Options: 

# Option 1: .netrc file (most secure for local development)
echo "machine your-registry.example.com login $REGISTRY_USER password $REGISTRY_TOKEN" > ~/.netrc
chmod 600 ~/.netrc
pip install --extra-index-url https://your-registry.example.com/simple/ askrita

# Option 2: Poetry with credential storage
poetry config repositories.private https://your-registry.example.com/simple/
poetry config http-basic.private $REGISTRY_USER $REGISTRY_TOKEN
poetry add askrita

Security Best Practices for Private Registries:

  • Use API tokens instead of passwords when possible
  • Store credentials in environment variables or secure credential stores
  • Use .netrc with proper permissions (chmod 600 ~/.netrc)
  • Enable Poetry keyring for secure credential storage
  • Never commit credentials to version control

From Source

# Direct install from Git
pip install git+https://<TOKEN>@github.com/cvs-health/askRITA.git@main

# Or install a specific tag
pip install git+https://<TOKEN>@github.com/cvs-health/askRITA.git@v0.13.13

For Development

git clone https://github.com/cvs-health/askRITA.gitcd askRITApip install poetrypoetry installInstalling dependencies from lock file
Package operations: 42 installs, 0 updates, 0 removals

Editable install from Git:

pip install -e git+https://github.com/cvs-health/askRITA.git@main#egg=askrita

Quick Start

Once installed, create a config file and run your first query:

from askrita import ConfigManager, SQLAgentWorkflow

config = ConfigManager("config.yaml")
workflow = SQLAgentWorkflow(config)

result = workflow.query("Show the top 10 customers by revenue")
print(result["answer"])