Skip to content

Commit 05bfe4f

Browse files
committed
fix: correct README.md imports and URLs for PyPI display
Fixes errors visible on PyPI package page (https://pypi.org/project/honeyhive/1.0.0rc3/): 1. Import Path Error: - Fixed: from honeyhive.tracer.decorators import trace (WRONG) - To: from honeyhive import trace (CORRECT) 2. Documentation URL Error: - Fixed: https://docs.honeyhive.ai/... (non-existent domain) - To: https://honeyhiveai.github.io/python-sdk/... (actual docs) 3. Code Simplification: - Removed redundant backward compatibility comment - Cleaned up Quick Start example for clarity The README.md file is the source for PyPI's project description page (configured via pyproject.toml: readme = "README.md") These fixes will appear on PyPI when the next version is published.
1 parent 5aec9a0 commit 05bfe4f

2 files changed

Lines changed: 12 additions & 8 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
## [Unreleased]
22

3+
### Fixed
4+
- **📚 README: Corrected Import Path for PyPI Display**
5+
- Fixed incorrect import `from honeyhive.tracer.decorators import trace` → `from honeyhive import trace`
6+
- Fixed documentation URL from `docs.honeyhive.ai` to `honeyhiveai.github.io/python-sdk`
7+
- Simplified Quick Start example (removed redundant comments)
8+
- Ensures PyPI package page shows correct usage examples
9+
310
### Changed
411
- **Version 1.0.0-rc3**: Bumped from 0.1.0-rc3 to reflect stable API
512
- **📚 Documentation: Strands Integration - Instance Method Pattern**

‎README.md‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ pip install honeyhive
7373

7474
**📋 Including in Your Project**
7575

76-
For detailed guidance on including HoneyHive in your `pyproject.toml`, see our [pyproject.toml Integration Guide](https://docs.honeyhive.ai/how-to/deployment/pyproject-integration.html).
76+
For detailed guidance on including HoneyHive in your `pyproject.toml`, see our [pyproject.toml Integration Guide](https://honeyhiveai.github.io/python-sdk/how-to/deployment/pyproject-integration.html).
7777

7878
### Development Installation
7979

@@ -124,18 +124,15 @@ tox -e format && tox -e lint
124124
### Basic Usage
125125

126126
```python
127-
from honeyhive import HoneyHiveTracer
128-
from honeyhive.tracer.decorators import trace
127+
from honeyhive import HoneyHiveTracer, trace
129128

130-
# Initialize tracer using the recommended init method (simplified API)
129+
# Initialize tracer
131130
tracer = HoneyHiveTracer.init(
132131
api_key="your-api-key",
133-
source="production" # project derived from API key automatically
132+
project="your-project",
133+
source="production"
134134
)
135135

136-
# Backward compatibility: project parameter still accepted but optional
137-
# tracer = HoneyHiveTracer.init(api_key="your-api-key", project="your-project", source="production")
138-
139136
# Use unified decorator for automatic tracing (works with both sync and async)
140137
@trace(event_type="demo", event_name="my_function")
141138
def my_function():

0 commit comments

Comments
 (0)