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

{python_alfresco_api-1.1.0 → python_alfresco_api-1.1.1}/.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.1}/CHANGELOG.md

@@ -1,13 +1,25 @@
 # 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.0] - 2025-07-18
+## [1.1.0] - 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/ dirignored so core/downloads and raw core /downloads get checked in
+ 
+### 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)
 
 ### Added
   - Implemented hierarchical client architecture with three-tier organization  and lazy loading (3 tiers doesn't count optional master). This is generated from raw clients (previously had 7 files one per client). 

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

@@ -11,7 +11,7 @@ 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 +51,7 @@ recursive-include scripts *.sh
 
 # Exclude cursor files
 exclude *.cursormemory
+recursive-exclude memory-bank *
 
 # Exclude development and build files
 exclude .gitignore
@@ -72,6 +73,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.1}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: python-alfresco-api
-Version: 1.1.0
+Version: 1.1.1
 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
@@ -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
@@ -502,7 +502,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 +535,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.1}/README.md

@@ -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
@@ -460,7 +460,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 +493,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.1}/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).

python_alfresco_api-1.1.1/docs/core/downloads/downloads_api.md

@@ -0,0 +1,425 @@
+# Downloads Operations - Core API
+
+Auto-generated from V1.1 hierarchical code on 2025-07-15 00:36:43
+
+## Overview
+
+Downloads operations for the Core API.
+
+## Usage
+
+```python
+from python_alfresco_api import ClientFactory
+
+# Create factory and client
+factory = ClientFactory(base_url="http://localhost:8080")
+core_client = factory.create_core_client()
+
+# Access downloads operations
+downloads_ops = core_client.downloads
+
+# Real method examples (sync):
+result = downloads_ops.cancel_download(download_id="abc123-def456")
+result = downloads_ops.cancel_download_async(download_id="abc123-def456")
+result = downloads_ops.cancel_download_detailed(download_id="abc123-def456")
+
+# Real method examples (async):
+result = await downloads_ops.cancel_download_async(download_id="abc123-def456")
+result = await downloads_ops.cancel_download_async_async(download_id="abc123-def456")
+result = await downloads_ops.cancel_download_detailed_async(download_id="abc123-def456")
+```
+
+## Available Methods
+
+This subsection provides 15 operations:
+
+### `cancel_download(self, download_id: Any) -> python_alfresco_api.clients.core.downloads.models.DownloadsResponse`
+
+Cancel Download operation.
+
+Perfect for MCP servers and downloads workflows.
+Returns simplified response for common use cases.
+
+**Parameters:**
+- `download_id`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.cancel_download(download_id="abc123-def456")
+
+# 2. Basic async
+result = await downloads_ops.cancel_download_async(download_id="abc123-def456")
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.cancel_download_detailed(download_id="abc123-def456")
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.cancel_download_detailed_async(download_id="abc123-def456")
+```
+
+### `cancel_download_async(self, download_id: Any) -> python_alfresco_api.clients.core.downloads.models.DownloadsResponse`
+
+Cancel Download operation (async).
+
+Perfect for MCP servers and downloads workflows.
+Returns simplified response for common use cases.
+
+**Parameters:**
+- `download_id`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.cancel_download_async(download_id="abc123-def456")
+
+# 2. Basic async
+result = await downloads_ops.cancel_download_async_async(download_id="abc123-def456")
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.cancel_download_async_detailed(download_id="abc123-def456")
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.cancel_download_async_detailed_async(download_id="abc123-def456")
+```
+
+### `cancel_download_detailed(self, download_id: Any)`
+
+Cancel Download operation (detailed).
+
+Perfect for MCP servers needing full HTTP response details.
+Returns complete Response object with status_code, headers, content, parsed.
+
+**Parameters:**
+- `download_id`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.cancel_download_detailed(download_id="abc123-def456")
+
+# 2. Basic async
+result = await downloads_ops.cancel_download_detailed_async(download_id="abc123-def456")
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.cancel_download_detailed_detailed(download_id="abc123-def456")
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.cancel_download_detailed_detailed_async(download_id="abc123-def456")
+```
+
+### `cancel_download_detailed_async(self, download_id: Any)`
+
+Cancel Download operation (detailed, async).
+
+Perfect for MCP servers needing full HTTP response details.
+Returns complete Response object with status_code, headers, content, parsed.
+
+**Parameters:**
+- `download_id`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.cancel_download_detailed_async(download_id="abc123-def456")
+
+# 2. Basic async
+result = await downloads_ops.cancel_download_detailed_async_async(download_id="abc123-def456")
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.cancel_download_detailed_async_detailed(download_id="abc123-def456")
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.cancel_download_detailed_async_detailed_async(download_id="abc123-def456")
+```
+
+### `create_download(self, body: Any, fields: Any) -> python_alfresco_api.clients.core.downloads.models.DownloadsResponse`
+
+Create Download operation.
+
+Perfect for MCP servers and downloads workflows.
+Returns simplified response for common use cases.
+
+**Parameters:**
+- `body`: typing.Any (required)
+- `fields`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.create_download(body=request_data, fields=...)
+
+# 2. Basic async
+result = await downloads_ops.create_download_async(body=request_data, fields=...)
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.create_download_detailed(body=request_data, fields=...)
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.create_download_detailed_async(body=request_data, fields=...)
+```
+
+### `create_download_async(self, body: Any, fields: Any) -> python_alfresco_api.clients.core.downloads.models.DownloadsResponse`
+
+Create Download operation (async).
+
+Perfect for MCP servers and downloads workflows.
+Returns simplified response for common use cases.
+
+**Parameters:**
+- `body`: typing.Any (required)
+- `fields`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.create_download_async(body=request_data, fields=...)
+
+# 2. Basic async
+result = await downloads_ops.create_download_async_async(body=request_data, fields=...)
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.create_download_async_detailed(body=request_data, fields=...)
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.create_download_async_detailed_async(body=request_data, fields=...)
+```
+
+### `create_download_detailed(self, body: Any, fields: Any)`
+
+Create Download operation (detailed).
+
+Perfect for MCP servers needing full HTTP response details.
+Returns complete Response object with status_code, headers, content, parsed.
+
+**Parameters:**
+- `body`: typing.Any (required)
+- `fields`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.create_download_detailed(body=request_data, fields=...)
+
+# 2. Basic async
+result = await downloads_ops.create_download_detailed_async(body=request_data, fields=...)
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.create_download_detailed_detailed(body=request_data, fields=...)
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.create_download_detailed_detailed_async(body=request_data, fields=...)
+```
+
+### `create_download_detailed_async(self, body: Any, fields: Any)`
+
+Create Download operation (detailed, async).
+
+Perfect for MCP servers needing full HTTP response details.
+Returns complete Response object with status_code, headers, content, parsed.
+
+**Parameters:**
+- `body`: typing.Any (required)
+- `fields`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.create_download_detailed_async(body=request_data, fields=...)
+
+# 2. Basic async
+result = await downloads_ops.create_download_detailed_async_async(body=request_data, fields=...)
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.create_download_detailed_async_detailed(body=request_data, fields=...)
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.create_download_detailed_async_detailed_async(body=request_data, fields=...)
+```
+
+### `get_download(self, download_id: Any, fields: Any) -> python_alfresco_api.clients.core.downloads.models.DownloadsResponse`
+
+Get Download operation.
+
+Perfect for MCP servers and downloads workflows.
+Returns simplified response for common use cases.
+
+**Parameters:**
+- `download_id`: typing.Any (required)
+- `fields`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.get_download(download_id="abc123-def456", fields=...)
+
+# 2. Basic async
+result = await downloads_ops.get_download_async(download_id="abc123-def456", fields=...)
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.get_download_detailed(download_id="abc123-def456", fields=...)
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.get_download_detailed_async(download_id="abc123-def456", fields=...)
+```
+
+### `get_download_async(self, download_id: Any, fields: Any) -> python_alfresco_api.clients.core.downloads.models.DownloadsResponse`
+
+Get Download operation (async).
+
+Perfect for MCP servers and downloads workflows.
+Returns simplified response for common use cases.
+
+**Parameters:**
+- `download_id`: typing.Any (required)
+- `fields`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.get_download_async(download_id="abc123-def456", fields=...)
+
+# 2. Basic async
+result = await downloads_ops.get_download_async_async(download_id="abc123-def456", fields=...)
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.get_download_async_detailed(download_id="abc123-def456", fields=...)
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.get_download_async_detailed_async(download_id="abc123-def456", fields=...)
+```
+
+### `get_download_detailed(self, download_id: Any, fields: Any)`
+
+Get Download operation (detailed).
+
+Perfect for MCP servers needing full HTTP response details.
+Returns complete Response object with status_code, headers, content, parsed.
+
+**Parameters:**
+- `download_id`: typing.Any (required)
+- `fields`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.get_download_detailed(download_id="abc123-def456", fields=...)
+
+# 2. Basic async
+result = await downloads_ops.get_download_detailed_async(download_id="abc123-def456", fields=...)
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.get_download_detailed_detailed(download_id="abc123-def456", fields=...)
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.get_download_detailed_detailed_async(download_id="abc123-def456", fields=...)
+```
+
+### `get_download_detailed_async(self, download_id: Any, fields: Any)`
+
+Get Download operation (detailed, async).
+
+Perfect for MCP servers needing full HTTP response details.
+Returns complete Response object with status_code, headers, content, parsed.
+
+**Parameters:**
+- `download_id`: typing.Any (required)
+- `fields`: typing.Any (required)
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.get_download_detailed_async(download_id="abc123-def456", fields=...)
+
+# 2. Basic async
+result = await downloads_ops.get_download_detailed_async_async(download_id="abc123-def456", fields=...)
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.get_download_detailed_async_detailed(download_id="abc123-def456", fields=...)
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.get_download_detailed_async_detailed_async(download_id="abc123-def456", fields=...)
+```
+
+### `get_httpx_client(self)`
+
+Get direct access to raw httpx client for advanced operations.
+
+Perfect for MCP servers that need raw HTTP access.
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.get_httpx_client()
+
+# 2. Basic async
+result = await downloads_ops.get_httpx_client_async()
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.get_httpx_client_detailed()
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.get_httpx_client_detailed_async()
+```
+
+### `get_httpx_client_detailed(self)`
+
+Get Httpx Client operation (detailed sync).
+
+Perfect for MCP servers needing full HTTP response details.
+Returns complete Response object with status_code, headers, content, parsed.
+
+Returns:
+    Response: Complete response with status_code, headers, content, parsed
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.get_httpx_client_detailed()
+
+# 2. Basic async
+result = await downloads_ops.get_httpx_client_detailed_async()
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.get_httpx_client_detailed_detailed()
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.get_httpx_client_detailed_detailed_async()
+```
+
+### `get_httpx_client_detailed_async(self)`
+
+Get Httpx Client operation (detailed async).
+
+Perfect for MCP servers needing full HTTP response details.
+Returns complete Response object with status_code, headers, content, parsed.
+
+Returns:
+    Response: Complete response with status_code, headers, content, parsed
+
+**Usage Patterns:**
+```python
+# 1. Basic sync
+result = downloads_ops.get_httpx_client_detailed_async()
+
+# 2. Basic async
+result = await downloads_ops.get_httpx_client_detailed_async_async()
+
+# 3. Detailed sync (with full HTTP response)
+result = downloads_ops.get_httpx_client_detailed_async_detailed()
+
+# 4. Detailed async (with full HTTP response)
+result = await downloads_ops.get_httpx_client_detailed_async_detailed_async()
+```
+
+## Models
+
+Operation-specific Pydantic models are available in:
+```python
+from python_alfresco_api.clients.core.downloads.models import *
+```
+
+## Related Documentation
+
+- [Core API Overview](../core_api.md)
+- [V1.1 Architecture](../../clients_doc.md)