python-alfresco-api 1.1.0__tar.gz → 1.1.2__tar.gz

{python_alfresco_api-1.1.0 → python_alfresco_api-1.1.2}/.gitignore

@@ -11,7 +11,7 @@ __pycache__/
 build/
 develop-eggs/
 dist/
-downloads/
+/downloads/
 eggs/
 .eggs/
 lib/
@@ -142,6 +142,7 @@ dmypy.json
 .cursormemory
 .cursor/
 *.cursormemory
+memory-bank/
 
 # macOS
 .DS_Store
@@ -186,7 +187,6 @@ test-reports/
 coverage-reports/
 
 # Release preparation files (temporary)
-publish_to_pypi.py
 RELEASE_NOTES_*.md
 RELEASE_INSTRUCTIONS.md
 RELEASE_SUMMARY.md

{python_alfresco_api-1.1.0 → python_alfresco_api-1.1.2}/CHANGELOG.md

@@ -1,12 +1,81 @@
 # Changelog
 
 All notable changes to python-alfresco-api will be documented in this file.
-
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+## [1.1.2] - 2025-09-29
+
+### Enhanced
+- **Timeout Configuration System**: Comprehensive overhaul of timeout handling throughout the client hierarchy
+  - Removed hardcoded 30-second defaults from `AuthUtil` and `OAuth2AuthUtil` constructors
+  - Implemented proper None timeout handling - when no timeout specified, system/ticket defaults apply
+  - Enhanced parameter priority chain: `auth_util parameters > explicit parameters > environment variables > None`
+  - Updated all 7 main clients to conditionally pass timeout to `AuthenticatedClient` only when specified
+  - Modified httpx client creation in auth utilities to not get a timeout if None
+
+### Added
+- **Parameter Priority Logic**: Enhanced `ClientFactory` to respect auth_util parameters as highest priority
+  - Auth_util parameters (timeout, base_url, verify_ssl, username, password) take precedence over factory parameters
+  - Added username/password property access from any auth_util type
+  - Comprehensive parameter propagation verification throughout client hierarchy
+- **Environment Configuration**: Extended timeout support in environment variables
+  - Added `ALFRESCO_TIMEOUT` environment variable support
+  - Added `ALFRESCO_FILE_IO_TIMEOUT` configuration option (not used currently)
+  - Updated priority documentation in `sample-dot-env.txt`
+- **Comprehensive Testing**: New test suite `test_client_factory_configuration.py` with 15 test methods
+  - Tests timeout priority chain across all scenarios
+  - Verifies parameter propagation to raw and httpx clients
+  - Validates MCP server pattern compatibility
+  - Tests None timeout handling and system default behavior
+
+### Changed
+- **ClientFactory**: Enhanced constructor parameter handling
+  - Changed `timeout: int = 30` to `timeout: Optional[int] = None`
+  - Improved auth_util parameter extraction and priority logic
+  - **Authentication Utilities**: Improved timeout parameter handling
+  - `AuthUtil` and `OAuth2AuthUtil` now accept `timeout: Optional[int] = None`
+  - httpx client creation doesn't use timeout if None
+  - Updated docstrings to reflect "None = use system defaults" behavior
+
+### Documentation
+- **README.md**: Enhanced Factory Pattern and Authentication sections
+  - Added parameter priority documentation
+  - Clarified timeout behavior when not specified
+  - Added platform-specific .env file setup instructions (copy for Windows, cp for Linux/Mac)
+- **sample-dot-env.txt**: timeout configuration examples
+  - Added timeout configuration section with examples
+  - Documented parameter priority order
+  - Added file I/O timeout option for large operations (not used currently)
+
+### Technical
+- **Content Utilities**: Enhanced `content_utils_highlevel.py`
+  - Improved Share-style create/upload functionality
+  - Better version handling (documents created with version 1.0)
+- **Project Configuration**: Updated version and build configuration
+  - Version bumped from 1.1.1 to 1.1.2 in `pyproject.toml`
+  - Cleaned up manifest includes
+
+
+## [1.1.1] - 2025-07-21
+
+### Changes
+  - Updated __init__.py files to have all things in __all_  so they get included in the package 
+  - Now have basic requirements.txt, requirements-dev.txt for development.txt,  and new
+    requirements-codegen.txt for advanced development where raw clients, 
+    high level clients, or documentation  needs to be regenerated
+  - Run_tests.py performance test is now the time of running the whole test suite, not a few client creates
+  - Pyproject has added includes for package and sdist
+  - Fix gitignore to not cause downloads/ ignored so core/downloads and raw core /downloads get checked in
+  - version updated to v1.1.1
+ 
+### Documentation
+  - Readme: reworded build with source description
+  - Readme: tests section at the end now develop and test
+  - Removed docs for eliminated core.folders (use ops in nodes)
+
 ## [1.1.0] - 2025-07-18
 
 ### Added

{python_alfresco_api-1.1.0 → python_alfresco_api-1.1.2}/MANIFEST.in

@@ -5,13 +5,12 @@
 include README.md
 include LICENSE
 include CHANGELOG.md
-include CHANGELOG_V1_1_0.md
 include sample-dot-env.txt
 
 # Include requirements files
 include requirements.txt
 include requirements-dev.txt
-#include tests/requirements-test.txt
+include requirements-codegen.txt
 
 # Include configuration files
 include setup.py
@@ -51,6 +50,7 @@ recursive-include scripts *.sh
 
 # Exclude cursor files
 exclude *.cursormemory
+recursive-exclude memory-bank *
 
 # Exclude development and build files
 exclude .gitignore
@@ -72,6 +72,5 @@ recursive-exclude * dist
 recursive-exclude * venv
 recursive-exclude * .venv
 
-# Include model files
-recursive-include python_alfresco_api/models *.py
-recursive-include python_alfresco_api/raw_clients *.py 
+# Include all Python files in package
+recursive-include python_alfresco_api/ *.py 

{python_alfresco_api-1.1.0 → python_alfresco_api-1.1.2}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: python-alfresco-api
-Version: 1.1.0
+Version: 1.1.2
 Summary: Python Client for all Alfresco Content Services REST APIs, with Pydantic v2 Models, and Event Support
 Project-URL: Homepage, https://github.com/stevereiner/python-alfresco-api
 Project-URL: Repository, https://github.com/stevereiner/python-alfresco-api
 Project-URL: Documentation, https://github.com/stevereiner/python-alfresco-api/docs
 Project-URL: Bug Tracker, https://github.com/stevereiner/python-alfresco-api/issues
-Author-email: Steve Reiner <stevereiner@integratedsemantics.com>
+Author-email: Steve Reiner <example@example.com>
 License: Apache-2.0
 License-File: LICENSE
 Keywords: alfresco,content-management,document-management,ecm,rest-api
@@ -50,7 +50,7 @@ Note this uses the remote Alfresco REST APIs. Not for in-process development in
 A modern, type-safe Python client library for Alfresco Content Services REST APIs with dual model architecture (attrs + Pydantic) and async support.
 
 [![PyPI version](https://img.shields.io/pypi/v/python-alfresco-api.svg)](https://pypi.org/project/python-alfresco-api/)
-[![PyPI downloads](https://img.shields.io/pypi/dm/python-alfresco-api.svg)](https://pypi.org/project/python-alfresco-api/)
+[![PyPI downloads](https://pepy.tech/badge/python-alfresco-api)](https://pepy.tech/project/python-alfresco-api)
 [![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
 [![Pydantic](https://img.shields.io/badge/pydantic-v2-green.svg)](https://pydantic.dev/)
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
@@ -153,7 +153,7 @@ pip install python-alfresco-api
 
 ### Development with source
 
-For development your project with source of python-alfresco-api for debugging
+For development of your project using python-alfresco-api to have debugging with source:
 
 ```bash
 # After setting up virtual environment above
@@ -197,8 +197,11 @@ Community version from Github
 
 For easy configuration, copy the sample environment file:
 ```bash
+# Windows
+copy sample-dot-env.txt .env
+# Mac and Linux
 cp sample-dot-env.txt .env
-# Edit .env with your Alfresco settings
+# Edit .env and your Alfresco settings
 ```
 
 ## Factory Pattern 
@@ -218,6 +221,9 @@ factory = ClientFactory(
     password="admin"
 )
 
+Note 1: the priority order of ClientFactory parameters: 1. in auth_util passed in, 2. in other parameters passed into ClientFactory, 3. in enviroment .env, etc.
+Note 2. For timeout, if not in 1-3, no default will be used. The settings for tickets or your system will be used.
+
 # Create individual clients (all share same authentication session)
 auth_client = factory.create_auth_client()
 core_client = factory.create_core_client()
@@ -247,6 +253,9 @@ auth_util = AuthUtil(
     password="admin"
 )
 
+Note 1: the priority order of ClientFactory parameters: 1. in auth_util passed in, 2. in other parameters passed into ClientFactory, 3. in enviroment .env, etc.
+Note 2. For timeout, if not in 1-3, no default will be used. The settings for tickets or your system will be used.
+
 # Use with factory for shared authentication
 factory = ClientFactory(auth_util=auth_util)
 clients = factory.create_all_clients()
@@ -502,7 +511,27 @@ await event_client.start_listening()
 For complete development documentation including the **3-step generation process** (Pydantic models → HTTP clients → High-level APIs), see **[📖 Package Developers Guide](docs/PACKAGE_DEVELOPERS_GUIDE.md)**.
 
 
-## 🧪 Testing
+## 🧪 Development and Testing
+
+### Development Setup
+
+For development, testing, and contributing:
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+For most development work on python-alfresco-api, you can develop directly without regenerating code:
+
+```bash
+git clone https://github.com/stevereiner/python-alfresco-api.git
+cd python-alfresco-api
+
+# Install in development mode
+pip install -e .
+```
+
+> **Note**: For proper pytest execution, work from the source directory with `pip install -e .` rather than testing from separate directories. This avoids import path conflicts.
 
 ### Run Tests
 
@@ -515,8 +544,16 @@ pytest
 # Run all tests with coverage
 pytest --cov=python_alfresco_api --cov-report=html
 
-# Or use the custom test runner for enhanced output
+# Custom test runner with additional features
 python run_tests.py
+# Features:
+# - Environment validation (venv, dependencies)
+# - Colored output with progress tracking
+# - Test selection for 44%+ coverage baseline
+# - Performance metrics (client creation speed)
+# - Live Alfresco server detection
+# - HTML coverage reports (htmlcov/index.html)
+# - Test summary with next steps
 ```
 
 ### Live Integration Tests

{python_alfresco_api-1.1.0 → python_alfresco_api-1.1.2}/README.md

@@ -8,7 +8,7 @@ Note this uses the remote Alfresco REST APIs. Not for in-process development in
 A modern, type-safe Python client library for Alfresco Content Services REST APIs with dual model architecture (attrs + Pydantic) and async support.
 
 [![PyPI version](https://img.shields.io/pypi/v/python-alfresco-api.svg)](https://pypi.org/project/python-alfresco-api/)
-[![PyPI downloads](https://img.shields.io/pypi/dm/python-alfresco-api.svg)](https://pypi.org/project/python-alfresco-api/)
+[![PyPI downloads](https://pepy.tech/badge/python-alfresco-api)](https://pepy.tech/project/python-alfresco-api)
 [![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
 [![Pydantic](https://img.shields.io/badge/pydantic-v2-green.svg)](https://pydantic.dev/)
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
@@ -111,7 +111,7 @@ pip install python-alfresco-api
 
 ### Development with source
 
-For development your project with source of python-alfresco-api for debugging
+For development of your project using python-alfresco-api to have debugging with source:
 
 ```bash
 # After setting up virtual environment above
@@ -155,8 +155,11 @@ Community version from Github
 
 For easy configuration, copy the sample environment file:
 ```bash
+# Windows
+copy sample-dot-env.txt .env
+# Mac and Linux
 cp sample-dot-env.txt .env
-# Edit .env with your Alfresco settings
+# Edit .env and your Alfresco settings
 ```
 
 ## Factory Pattern 
@@ -176,6 +179,9 @@ factory = ClientFactory(
     password="admin"
 )
 
+Note 1: the priority order of ClientFactory parameters: 1. in auth_util passed in, 2. in other parameters passed into ClientFactory, 3. in enviroment .env, etc.
+Note 2. For timeout, if not in 1-3, no default will be used. The settings for tickets or your system will be used.
+
 # Create individual clients (all share same authentication session)
 auth_client = factory.create_auth_client()
 core_client = factory.create_core_client()
@@ -205,6 +211,9 @@ auth_util = AuthUtil(
     password="admin"
 )
 
+Note 1: the priority order of ClientFactory parameters: 1. in auth_util passed in, 2. in other parameters passed into ClientFactory, 3. in enviroment .env, etc.
+Note 2. For timeout, if not in 1-3, no default will be used. The settings for tickets or your system will be used.
+
 # Use with factory for shared authentication
 factory = ClientFactory(auth_util=auth_util)
 clients = factory.create_all_clients()
@@ -460,7 +469,27 @@ await event_client.start_listening()
 For complete development documentation including the **3-step generation process** (Pydantic models → HTTP clients → High-level APIs), see **[📖 Package Developers Guide](docs/PACKAGE_DEVELOPERS_GUIDE.md)**.
 
 
-## 🧪 Testing
+## 🧪 Development and Testing
+
+### Development Setup
+
+For development, testing, and contributing:
+
+```bash
+pip install -r requirements-dev.txt
+```
+
+For most development work on python-alfresco-api, you can develop directly without regenerating code:
+
+```bash
+git clone https://github.com/stevereiner/python-alfresco-api.git
+cd python-alfresco-api
+
+# Install in development mode
+pip install -e .
+```
+
+> **Note**: For proper pytest execution, work from the source directory with `pip install -e .` rather than testing from separate directories. This avoids import path conflicts.
 
 ### Run Tests
 
@@ -473,8 +502,16 @@ pytest
 # Run all tests with coverage
 pytest --cov=python_alfresco_api --cov-report=html
 
-# Or use the custom test runner for enhanced output
+# Custom test runner with additional features
 python run_tests.py
+# Features:
+# - Environment validation (venv, dependencies)
+# - Colored output with progress tracking
+# - Test selection for 44%+ coverage baseline
+# - Performance metrics (client creation speed)
+# - Live Alfresco server detection
+# - HTML coverage reports (htmlcov/index.html)
+# - Test summary with next steps
 ```
 
 ### Live Integration Tests

{python_alfresco_api-1.1.0 → python_alfresco_api-1.1.2}/docs/core/core_api.md

@@ -6,9 +6,8 @@ Auto-generated from actual V1.1 code on 2025-07-15 00:36:43
 
 Main client for Alfresco Core API operations.
 
-Provides lazy-loaded access to ALL 22 Core API operation groups:
+Provides lazy-loaded access to ALL 21 Core API operation groups:
 - nodes: Node management (files, folders, metadata)
-- folders: Folder-specific operations  
 - content: Content upload/download operations
 - versions: Version control (checkout, checkin, cancel)
 - sites: Site/collaboration management
@@ -288,10 +287,7 @@ Access to downloads operations (3 operations).
 ### `favorites`
 Access to favorites operations (8 operations).
 
-### `folders`
-DEPRECATED: Use nodes.create_folder() instead.
 
-Folder operations are now part of the nodes client.
 
 ### `groups`
 Access to groups operations (9 operations).