Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For local development, Please change `version = "RELEASE_VERSION"` with any sema
### Installation

```python
pip install javelin_sdk
pip install javelin-sdk
```

### Quick Start Guide
Expand Down Expand Up @@ -56,7 +56,7 @@ poetry install

```bash
# Uninstall any existing version
pip uninstall javelin_sdk -y
pip uninstall javelin-sdk -y

# Build the package
poetry build
Expand All @@ -69,34 +69,40 @@ pip install dist/javelin_sdk-<version>-py3-none-any.whl

Javelin provides universal endpoints that allow you to use a consistent interface across different LLM providers. Here are the main patterns:

#### Azure OpenAI
### Azure OpenAI

- [Basic Azure OpenAI integration](examples/azure-openai/azure-universal.py)
- [Universal endpoint implementation](examples/azure-openai/javelin_azureopenai_univ_endpoint.py)
- [OpenAI-compatible interface](examples/azure-openai/openai_compatible_univ_azure.py)

#### Bedrock
### Bedrock

- [Basic Bedrock integration](examples/bedrock/bedrock_client_universal.py)
- [Universal endpoint implementation](examples/bedrock/javelin_bedrock_univ_endpoint.py)
- [OpenAI-compatible interface](examples/bedrock/openai_compatible_univ_bedrock.py)

#### Gemini
### Gemini

- [Basic Gemini integration](examples/gemini/gemini-universal.py)
- [Universal endpoint implementation](examples/gemini/javelin_gemini_univ_endpoint.py)
- [OpenAI-compatible interface](examples/gemini/openai_compatible_univ_gemini.py)

### Agent Examples
- [CrewAI integration](examples/agents/crewai_javelin.ipynb)
- [LangGraph integration](examples/agents/langgraph_javelin.ipynb)

### Basic Examples

- [Asynchronous example](examples/route_examples/aexample.py)
- [Synchronous example](examples/route_examples/example.py)
- [Drop-in replacement example](examples/route_examples/drop_in_replacement.py)

### Advanced Examples

- [Document processing](examples/gemini/document_processing.py)
- [RAG implementation](examples/rag/javelin_rag_embeddings_demo.ipynb)

### Agent Examples

- [CrewAI integration](examples/agents/crewai_javelin.ipynb)
- [LangGraph integration](examples/agents/langgraph_javelin.ipynb)

## Additional Integration Patterns

For more detailed examples and integration patterns, check out:
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
name = "javelin-sdk"
version = "RELEASE_VERSION"
description = "Python client for Javelin"
authors = ["Sharath Rajasekar <sharath@getjavelin.io>"]
authors = ["Sharath Rajasekar <sharath@getjavelin.com>"]
readme = "README.md"
license = "Apache-2.0"
packages = [
{ include = "javelin_cli" },
{ include = "javelin_sdk" },
]
homepage = "https://getjavelin.io"
homepage = "https://getjavelin.com"

[tool.poetry.scripts]
javelin = "javelin_cli.cli:main"
Expand Down
Loading