Skip to content

Commit 9361360

Browse files
committed
feat: Minor updates to README and .gitignore
This commit includes minor updates to the README and .gitignore files. The following changes were made: - Updated the README to reflect the current state of the project, including removing outdated features from the feature list. - Added `future_todos.txt` to .gitignore.
1 parent 8979758 commit 9361360

File tree

2 files changed

+3
-7
lines changed

2 files changed

+3
-7
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,5 @@ layout.md
1616
openrouter_api_spec.md
1717
openrouter-client.md
1818
test_imports.py
19+
future_todos.txt
1920
*.json

README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,13 @@ An unofficial Python client for [OpenRouter](https://openrouter.ai/), providing
77

88
## Features
99

10-
- **Full API Support**: Access all major OpenRouter endpoints including chat completions, text completions, model information, generations, credits, and API key management
10+
- **Full API Support (Almost)**: Access all major OpenRouter endpoints including chat completions, text completions, model information, generations, credits, and API key management
1111
- **Streaming Support**: Stream responses from chat and completion endpoints
1212
- **Automatic Rate Limiting**: Automatically configures rate limits based on your API key's limits using SmartSurge
1313
- **Smart Retries**: Built-in retry logic with exponential backoff for reliable API communication
1414
- **Type Safety**: Fully typed interfaces with Pydantic models for all request and response data
15-
- **Function Calling**: Built-in support for OpenAI-style function calling with tools and decorators
16-
- **Prompt Caching**: Support for prompt caching on compatible models (OpenAI and Anthropic)
15+
- **Tool Calling**: Built-in support for tool-calling with helper functions and decorators
1716
- **Safe Key Management**: Secure API key management with in-memory encryption and extensible secrets management
18-
- **Context Length Management**: Automatic tracking and querying of model context lengths
19-
- **Credit Management**: Monitor usage, calculate rate limits based on available credits
2017
- **Comprehensive Testing**: Extensive test suite with both local unit tests and remote integration tests
2118

2219
## Disclaimer
@@ -29,8 +26,6 @@ This project is an open-source interface designed to interact with the OpenRoute
2926

3027
## Installation
3128

32-
> **Note**: The PyPi package won't be published until initial testing for `openrouter-client-unofficial` is complete.
33-
3429
```bash
3530
pip install openrouter-client-unofficial
3631
```

0 commit comments

Comments
 (0)