Installation

​

Overview

This guide covers the installation of Julep in various environments and configurations.

​

Prerequisites

Before installing Julep, ensure you have:

• Python 3.8+ or Node.js 16+ installed
• pip (for Python) or npm/bun (for Node.js) package manager
• A Julep API key (Get one here)

​

Package Installation

​

Python Installation

1. Using pip:

pip install julep

2. Using poetry:

poetry add julep

3. Using pipenv:

pipenv install julep

​

Node.js Installation

1. Using npm:

npm install @julep/sdk

2. Using yarn:

yarn add @julep/sdk

3. Using bun:

bun add @julep/sdk

​

Environment Setup

​

Setting up Environment Variables

It’s recommended to use environment variables for sensitive information like API keys:

1. Create a .env file in your project root:

JULEP_API_KEY=your_api_key_here
JULEP_ENVIRONMENT=production  # or development

2. Load the environment variables in your code:

​

Verification

To verify your installation:

​

Troubleshooting

Common installation issues and solutions:

1. API Key Issues

   • Ensure your API key is valid and properly set in environment variables
   • Check if you’re using the correct environment (production/development)

2. Version Compatibility

   • Make sure you’re using compatible versions of Python/Node.js
   • Update to the latest SDK version if you encounter issues

3. Docker Issues

   • Verify Docker is running and has sufficient resources
   • Check if required ports are available and not blocked

​

Next Steps

Now that you have Julep installed, you can: