diff --git a/README.md b/README.md index b235a60..697ecbc 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -69,34 +69,40 @@ pip install dist/javelin_sdk--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: diff --git a/pyproject.toml b/pyproject.toml index 83f80ce..07d7dfc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,14 +2,14 @@ name = "javelin-sdk" version = "RELEASE_VERSION" description = "Python client for Javelin" -authors = ["Sharath Rajasekar "] +authors = ["Sharath Rajasekar "] 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"