Skip to content

Commit ee8ed6c

Browse files
committed
docs: Fix documentation to showcase beautiful fluent API
- Reverted 44+ instances of wrong search_read usage back to fluent API - Fixed ResUser -> ResUsers import in client.md performance tips - All documentation now properly showcases ZENOO RPC's crown jewel: the fluent API - Maintained complete API coverage: fluent API (recommended) + low-level API (advanced) - Version bump to 0.1.8 for documentation improvements Files updated: - docs/api-reference/models/relationships.md: 15 instances reverted to fluent API - docs/api-reference/query/expressions.md: 16 instances reverted to fluent API - docs/api-reference/retry/index.md: 11 instances reverted to fluent API - docs/api-reference/retry/policies.md: 2 instances reverted to fluent API - docs/api-reference/client.md: Fixed ResUsers import, performance tips use fluent API - pyproject.toml: Version 0.1.7 -> 0.1.8 - src/zenoo_rpc/__init__.py: Version 0.1.7 -> 0.1.8 The beautiful fluent API is now properly showcased everywhere: partners = await client.model(ResPartner).filter(is_company=True).limit(10).all()
1 parent ca41517 commit ee8ed6c

29 files changed

Lines changed: 2049 additions & 1207 deletions

CHANGELOG.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,49 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1616
### Fixed
1717
- TBD for next release
1818

19+
## [0.1.7] - 2025-01-28
20+
21+
### Fixed
22+
- **Pydantic Warning**: Fixed field shadowing warning in ResPartner model by using ClassVar for odoo_name
23+
24+
## [0.1.6] - 2025-01-28
25+
26+
### Fixed
27+
- **Critical Fix**: Moved dependencies from flit config to proper [project] section for setuptools
28+
- **Package Dependencies**: Fixed dependency installation issue - dependencies now properly installed
29+
30+
## [0.1.5] - 2025-01-28
31+
32+
### Fixed
33+
- **Setuptools Configuration**: Added proper package discovery and dependency resolution
34+
- **Package Dependencies**: Fixed dependency installation issue in PyPI package
35+
36+
## [0.1.4] - 2025-01-28
37+
38+
### Fixed
39+
- **Build System**: Changed from flit to setuptools for better dependency resolution
40+
- **Package Dependencies**: Fixed dependency resolution issue in PyPI package
41+
42+
## [0.1.3] - 2025-01-28
43+
44+
### Fixed
45+
- **Package Dependencies**: Fixed dependency resolution issue in PyPI package
46+
47+
## [0.1.2] - 2025-01-28
48+
49+
### Fixed
50+
- **QueryBuilder.get() Method**: Fixed method signature to accept positional ID parameter (`client.model(ResPartner).get(1)`)
51+
- **LazyRelationship.all() Method**: Added missing `.all()` method for lazy relationship collections (`partner.child_ids.all()`)
52+
- **Model Instance Creation**: Fixed lazy loading to return proper model instances instead of raw dictionaries
53+
- **Authentication Context**: Ensured client context is properly propagated to lazy loading operations
54+
- **Caching Performance**: Fixed timeout issues with cached queries on large datasets
55+
- **API Consistency**: Restored full compatibility with documented README.md examples
56+
57+
### Improved
58+
- **Lazy Loading Performance**: Enhanced batch loading mechanism to prevent N+1 queries
59+
- **Type Safety**: Improved model instance creation with proper type annotations and IDE support
60+
- **Error Handling**: Better error messages and graceful fallbacks in lazy loading operations
61+
1962
## [0.1.1] - 2025-07-28
2063

2164
### Added

docs/advanced/performance.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,13 +106,13 @@ async with OptimizedClient("localhost") as client:
106106
### Connection Pool Management
107107

108108
```python
109-
from zenoo_rpc.transport.pool import EnhancedConnectionPool
109+
from zenoo_rpc.transport.pool import ConnectionPool
110110

111111
class HighPerformancePool:
112112
"""Enterprise-grade connection pool."""
113-
113+
114114
def __init__(self, base_url: str):
115-
self.pool = EnhancedConnectionPool(
115+
self.pool = ConnectionPool(
116116
base_url=base_url,
117117
pool_size=20, # Initial pool size
118118
max_connections=100, # Maximum connections

0 commit comments

Comments
 (0)