ipc-framework 1.1.0__tar.gz → 1.1.2__tar.gz

ipc_framework-1.1.2/CHANGELOG.md

@@ -0,0 +1,139 @@
+# Changelog
+
+All notable changes to this project 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).
+
+## [1.1.3] - 2024-01-XX
+
+### Documentation Distribution
+- **FIXED**: Documentation now included in published NPM package
+- **ADDED**: `docs/`, `examples/`, `test/` directories to NPM package files
+- **FIXED**: Documentation now included in Python package via updated MANIFEST.in
+- **PACKAGE SIZE**: NPM package now ~265KB (vs 25KB) with full documentation
+- **DISTRIBUTION**: Users can now access docs offline after `npm install`
+
+## [1.1.2] - 2024-01-XX
+
+### Fixed (PyPI Documentation)
+- **CRITICAL**: Fixed PyPI documentation to correctly describe Python TCP server (not WebSocket)
+- **CRITICAL**: Updated package references from `@ifesol/ipc-framework-js` to `@ifesol/ipc-framework-nodejs`
+- **CRITICAL**: Removed incorrect WebSocket architecture descriptions
+- **CRITICAL**: Updated to focus on Python server capabilities with Node.js client integration
+- **IMPROVED**: Added correct TCP-based performance characteristics and use cases
+
+### Changed (Documentation)
+- **BREAKING**: Documentation now correctly represents this as Python server package
+- **ARCHITECTURE**: Properly describes TCP socket communication (not WebSocket)
+- **EXAMPLES**: Python-focused examples with correct Node.js client integration
+- **METADATA**: Updated package description and keywords for better discoverability
+
+### Package Contents
+**NPM Package now includes:**
+- Core implementation (`index.js`, `src/tcp-client.js`)
+- **Full documentation** (`docs/nodejs-package.md`, `docs/api-reference.md`, etc.)
+- **Working examples** (`examples/basic-usage.js`, `examples/express-integration.js`)
+- **Tests** (`test/basic-test.js`)
+
+**Python Package now includes:**
+- All Python source code and examples
+- **Full documentation** (`docs/` directory with all .md files)
+- **CHANGELOG.md** for version history
+
+## [1.1.2] - 2024-01-XX
+
+### Documentation
+- **UPDATED**: Comprehensive `docs/nodejs-package.md` documentation with v1.1.1 fixes
+- **ADDED**: Complete API reference with TCP implementation details
+- **ADDED**: Express.js integration examples and patterns
+- **ADDED**: Microservices architecture examples
+- **ADDED**: Advanced usage patterns (connection pooling, message queuing)
+- **ADDED**: Performance optimization techniques
+- **ADDED**: Migration guide from broken v1.1.0
+- **ADDED**: Troubleshooting section with common issues
+- **REMOVED**: All outdated WebSocket/browser references
+
+### Changes
+- No code changes - documentation-only release
+- Package includes updated comprehensive documentation
+
+## [1.1.1] - 2024-01-XX
+
+### CRITICAL FIXES
+- **FIXED**: Replaced broken WebSocket implementation with TCP socket communication
+- **FIXED**: Removed module system conflicts (CommonJS/ESM) that caused require() errors
+- **FIXED**: Eliminated WebSocket dependency resolution issues  
+- **FIXED**: Removed complex Rollup/TypeScript build system causing distribution problems
+- **FIXED**: Context-dependent behavior that made package work from CLI but fail in scripts
+
+### Changed
+- **BREAKING**: Now uses TCP sockets instead of WebSockets for Python server communication
+- **ARCHITECTURE**: Simplified to pure CommonJS module (removed ESM complexity)
+- **BUILD**: Removed Rollup, TypeScript, and complex build pipeline 
+- **DEPENDENCIES**: Removed all external dependencies - now uses only Node.js built-ins
+- **PACKAGE**: Simplified structure with direct `index.js` entry point
+
+### Added
+- Full TCP message framing with proper buffering for reliable communication
+- Automatic reconnection with configurable attempts and delays
+- Heartbeat system for connection health monitoring
+- Express.js middleware integration helper
+- Comprehensive error handling and logging
+- Server-Sent Events example for real-time browser updates
+
+### Technical Details
+- Uses `net` module for raw TCP socket communication (matches Python server protocol)
+- Implements 4-byte length headers for proper message framing
+- Fixed message field names to match Python server (`message_id` vs `messageId`)
+- Added connection pooling support for high-throughput applications
+- Improved memory management with proper buffer cleanup
+
+### Migration from 1.1.0
+The v1.1.0 package was fundamentally broken. v1.1.1 is a complete rewrite:
+
+```javascript
+// OLD (v1.1.0) - BROKEN
+const { IPCClient } = require('@ifesol/ipc-framework-nodejs'); // Failed to load
+
+// NEW (v1.1.1) - WORKING  
+const { IPCClient } = require('@ifesol/ipc-framework-nodejs'); // ✅ Works correctly
+const client = new IPCClient('my-app');
+await client.connect(); // ✅ TCP connection to Python server
+```
+
+## [1.1.0] - 2024-01-XX
+
+### Fixed (Python Package Only)
+- **CRITICAL**: Fixed missing `create_response()` method in Message class
+- **CRITICAL**: Fixed socket timeout deadlock in client after successful handshake  
+- **CRITICAL**: Fixed threading deadlock in receive operations causing eternal hangs
+- **PERFORMANCE**: Optimized message handling and reduced memory usage
+- **STABILITY**: Improved error handling and connection resilience
+
+### Added (Python Package Only)
+- Enhanced logging for better debugging
+- Connection state validation
+- Automatic cleanup of failed connections
+- Performance monitoring capabilities
+
+### Technical Details (Python Package Only)
+- Removed socket timeout after successful connection establishment
+- Removed socket lock from `_receive_message()` method to prevent deadlocks
+- Added proper message creation API matching documentation
+- Fixed notification delivery mechanism
+
+## [1.0.0] - 2024-01-XX
+
+### Added
+- Initial release of IPC Framework
+- WebSocket-based communication (later found to be incompatible with Python servers)
+- Basic client-server messaging
+- Channel subscription system
+- Real-time notifications
+
+### Known Issues (Fixed in 1.1.1)
+- ❌ Used WebSocket instead of TCP (incompatible with Python servers)
+- ❌ Module system conflicts preventing package loading
+- ❌ Complex build system causing distribution issues
+- ❌ Dependency resolution problems with 'ws' package 

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

@@ -1,21 +1,25 @@
-# Include the README and other documentation
-include README.md
-include LICENSE
-include requirements.txt
-include pyproject.toml
-
-# Include example scripts
-recursive-include examples *.py
-
-# Include package data
-include ipc_framework/py.typed
-
-# Exclude development and build files
-exclude demo.py
-exclude .gitignore
-exclude *.yaml
-exclude *.yml
-global-exclude __pycache__
-global-exclude *.py[co]
-global-exclude *.so
+# Include the README and other documentation
+include README.md
+include LICENSE
+include requirements.txt
+include pyproject.toml
+
+# Include comprehensive documentation
+recursive-include docs *.md
+include CHANGELOG.md
+
+# Include example scripts
+recursive-include examples *.py
+
+# Include package data
+include ipc_framework/py.typed
+
+# Exclude development and build files
+exclude demo.py
+exclude .gitignore
+exclude *.yaml
+exclude *.yml
+global-exclude __pycache__
+global-exclude *.py[co]
+global-exclude *.so
 global-exclude .DS_Store 

ipc_framework-1.1.2/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: ipc-framework
+Version: 1.1.2
+Summary: Python IPC server for high-performance communication with Node.js applications using TCP sockets
+Home-page: https://github.com/ifesol/ipc-framework
+Author: IPC Framework Team
+Author-email: IPC Framework Team <ifesol@example.com>
+Maintainer-email: IPC Framework Team <ifesol@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/ifesol/ipc-framework
+Project-URL: Documentation, https://github.com/ifesol/ipc-framework#readme
+Project-URL: Repository, https://github.com/ifesol/ipc-framework.git
+Project-URL: Bug Tracker, https://github.com/ifesol/ipc-framework/issues
+Keywords: ipc,inter-process-communication,tcp,sockets,nodejs,python,server,microservices,real-time,messaging
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: examples
+Requires-Dist: psutil>=5.8.0; extra == "examples"
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0.0; extra == "dev"
+Requires-Dist: black>=21.0.0; extra == "dev"
+Requires-Dist: flake8>=3.8.0; extra == "dev"
+Requires-Dist: mypy>=0.910; extra == "dev"
+Requires-Dist: isort>=5.0.0; extra == "dev"
+Provides-Extra: all
+Requires-Dist: ipc-framework[dev,examples]; extra == "all"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# IPC Framework - Inter-Process Communication
+
+[![NPM companion](https://img.shields.io/badge/Node.js%20Package-v1.1.3-green.svg)](https://www.npmjs.com/package/@ifesol/ipc-framework-nodejs)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Efficient Inter-Process Communication Framework** for **Python ↔ Node.js** backend integration. This is the **Python server package** that enables seamless **bidirectional communication** with Node.js applications using TCP sockets.
+
+## 🐍 **Python Server Package**
+
+This package provides the **Python IPC server** for communication with Node.js clients.
+
+**✅ Production Ready Features:**
+- ✅ TCP socket server (high-performance, low-latency)
+- ✅ Hierarchical application and channel management
+- ✅ Request/response and publish/subscribe patterns
+- ✅ Connection pooling and auto-reconnection support
+- ✅ Thread-safe operation with robust error handling
+
+## 🚀 **Quick Start**
+
+### **Installation**
+
+```bash
+# Install Python IPC server
+pip install ipc-framework
+
+# Install Node.js client (separate package)
+npm install @ifesol/ipc-framework-nodejs
+```
+
+### **Python Server Usage**
+
+```python
+from ipc_framework import FrameworkServer, MessageType
+import time
+
+# Create server
+server = FrameworkServer(host="localhost", port=8888)
+
+# Create application and channel
+app = server.create_application("my_app", "My Application")
+api_channel = app.create_channel("api")
+
+# Handle requests from Node.js clients
+def handle_request(message):
+    action = message.payload.get('action')
+    
+    if action == 'get_data':
+        response = message.create_response({
+            'success': True,
+            'data': {'timestamp': time.time(), 'message': 'Hello from Python!'},
+            'server': 'Python IPC Framework'
+        })
+        
+        connection = server.connection_manager.get_connection(
+            message.payload.get('connection_id')
+        )
+        server.send_to_connection(connection, response)
+
+api_channel.set_handler(MessageType.REQUEST, handle_request)
+
+print("🐍 Python IPC Server starting on localhost:8888")
+server.start()
+```
+
+### **Node.js Client Usage**
+
+```javascript
+const { IPCClient } = require('@ifesol/ipc-framework-nodejs');
+
+async function main() {
+    const client = new IPCClient('my_app', {
+        host: 'localhost',
+        port: 8888
+    });
+
+    try {
+        await client.connect();
+        console.log('✅ Connected to Python server!');
+
+        const response = await client.sendRequest('api', {
+            action: 'get_data'
+        });
+
+        console.log('📨 Response from Python:', response.payload);
+    } catch (error) {
+        console.error('❌ Error:', error.message);
+    } finally {
+        client.disconnect();
+    }
+}
+
+main();
+```
+
+## 🎯 **Architecture Features**
+
+### **✅ Production-Ready Server:**
+- **High-performance TCP sockets** for low-latency communication
+- **Hierarchical structure** with applications and channels
+- **Message routing** and automatic connection management
+- **Thread-safe operations** with robust error handling
+
+### **✅ Communication Patterns:**
+- **Request/Response** - Direct client-server communication
+- **Publish/Subscribe** - Real-time notifications and broadcasts
+- **Channel-based routing** - Organized message handling
+- **Connection pooling** - Efficient resource management
+
+## 🏗️ **Integration with Node.js**
+
+This Python server works seamlessly with Node.js applications. Here's how to connect an Express.js app:
+
+**Node.js Express.js Integration:**
+```javascript
+const express = require('express');
+const { IPCClient } = require('@ifesol/ipc-framework-nodejs');
+
+const app = express();
+const pythonClient = new IPCClient('web_api');
+
+app.use(express.json());
+
+// Initialize connection to Python IPC server
+pythonClient.connect().then(() => {
+    console.log('🔗 Connected to Python IPC server');
+});
+
+// API endpoint proxying to Python backend
+app.post('/api/process', async (req, res) => {
+    try {
+        const result = await pythonClient.sendRequest('processing', {
+            action: 'process_user_data',
+            data: req.body,
+            connection_id: pythonClient.connectionId
+        });
+        
+        res.json(result.payload);
+    } catch (error) {
+        res.status(500).json({ error: error.message });
+    }
+});
+
+app.listen(3000, () => {
+    console.log('🌐 Express server running on port 3000');
+    console.log('📡 Proxying requests to Python IPC server');
+});
+```
+
+## 📊 **Performance Characteristics**
+
+| Feature | Performance | Details |
+|---------|-------------|---------|
+| **Connection Handling** | Sub-millisecond | Fast TCP connection establishment |
+| **Message Processing** | <1ms latency | Direct socket communication |
+| **Concurrent Connections** | 100+ clients | Thread-safe connection management |
+| **Message Throughput** | High-volume | Efficient message routing |
+| **Memory Usage** | Low footprint | Optimized Python implementation |
+| **Error Recovery** | Automatic | Robust connection cleanup |
+
+## 🎯 **Use Cases**
+
+This Python IPC server enables powerful hybrid architectures:
+
+### **Backend Services**
+- **AI/ML model serving** - Host machine learning models and serve predictions to Node.js frontends
+- **Data processing pipelines** - Heavy computational tasks handled by Python, coordinated with Node.js
+- **Real-time analytics** - Python analytics engines feeding real-time dashboards
+- **Scientific computing** - NumPy/SciPy computations accessible from Node.js applications
+
+### **Microservice Architecture**
+- **Polyglot microservices** - Python services integrated with Node.js API gateways
+- **Event-driven architecture** - Python services publishing events to Node.js consumers
+- **Service mesh integration** - Python backend services in cloud-native environments
+- **Legacy system integration** - Bridge existing Python systems with modern Node.js frontends
+
+### **Hybrid Applications**
+- **E-commerce platforms** - Python inventory/pricing engines with Node.js storefronts
+- **Financial services** - Python quantitative analysis with Node.js trading interfaces
+- **IoT platforms** - Python device controllers with Node.js monitoring dashboards
+- **Chat applications** - Python NLP processing with Node.js real-time messaging
+
+## 🆚 **Why Choose IPC over HTTP?**
+
+| HTTP API Approach | IPC Framework |
+|-------------------|---------------|
+| ❌ High latency overhead | ✅ Direct TCP communication |
+| ❌ Request/response only | ✅ Request/response + pub/sub |
+| ❌ Manual connection management | ✅ Automatic reconnection |
+| ❌ Complex error handling | ✅ Built-in fault tolerance |
+| ❌ No real-time capabilities | ✅ Live notifications |
+| ❌ Stateless limitations | ✅ Persistent connections |
+
+## 🔗 **Companion Packages**
+
+This Python server works with the Node.js client package:
+
+- **Node.js Client**: [@ifesol/ipc-framework-nodejs](https://www.npmjs.com/package/@ifesol/ipc-framework-nodejs) - Production-ready TCP client
+- **Installation**: `npm install @ifesol/ipc-framework-nodejs`
+- **Documentation**: [Node.js Package Docs](https://www.npmjs.com/package/@ifesol/ipc-framework-nodejs)
+
+## 🚀 **Getting Started**
+
+1. **Install the Python server:**
+   ```bash
+   pip install ipc-framework
+   ```
+
+2. **Install the Node.js client:**
+   ```bash
+   npm install @ifesol/ipc-framework-nodejs
+   ```
+
+3. **Run the examples above** to see the integration in action!
+
+## 📚 **Documentation**
+
+- [Python API Reference](https://github.com/ifesol/ipc-framework#python-api)
+- [Node.js Client Usage](https://www.npmjs.com/package/@ifesol/ipc-framework-nodejs)
+- [Integration Examples](https://github.com/ifesol/ipc-framework/tree/main/examples)
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## 🤝 Contributing
+
+Contributions welcome! Help us improve the Python ↔ Node.js IPC communication experience. 

ipc_framework-1.1.2/README.md

@@ -0,0 +1,228 @@
+# IPC Framework - Inter-Process Communication
+
+[![NPM companion](https://img.shields.io/badge/Node.js%20Package-v1.1.3-green.svg)](https://www.npmjs.com/package/@ifesol/ipc-framework-nodejs)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**Efficient Inter-Process Communication Framework** for **Python ↔ Node.js** backend integration. This is the **Python server package** that enables seamless **bidirectional communication** with Node.js applications using TCP sockets.
+
+## 🐍 **Python Server Package**
+
+This package provides the **Python IPC server** for communication with Node.js clients.
+
+**✅ Production Ready Features:**
+- ✅ TCP socket server (high-performance, low-latency)
+- ✅ Hierarchical application and channel management
+- ✅ Request/response and publish/subscribe patterns
+- ✅ Connection pooling and auto-reconnection support
+- ✅ Thread-safe operation with robust error handling
+
+## 🚀 **Quick Start**
+
+### **Installation**
+
+```bash
+# Install Python IPC server
+pip install ipc-framework
+
+# Install Node.js client (separate package)
+npm install @ifesol/ipc-framework-nodejs
+```
+
+### **Python Server Usage**
+
+```python
+from ipc_framework import FrameworkServer, MessageType
+import time
+
+# Create server
+server = FrameworkServer(host="localhost", port=8888)
+
+# Create application and channel
+app = server.create_application("my_app", "My Application")
+api_channel = app.create_channel("api")
+
+# Handle requests from Node.js clients
+def handle_request(message):
+    action = message.payload.get('action')
+    
+    if action == 'get_data':
+        response = message.create_response({
+            'success': True,
+            'data': {'timestamp': time.time(), 'message': 'Hello from Python!'},
+            'server': 'Python IPC Framework'
+        })
+        
+        connection = server.connection_manager.get_connection(
+            message.payload.get('connection_id')
+        )
+        server.send_to_connection(connection, response)
+
+api_channel.set_handler(MessageType.REQUEST, handle_request)
+
+print("🐍 Python IPC Server starting on localhost:8888")
+server.start()
+```
+
+### **Node.js Client Usage**
+
+```javascript
+const { IPCClient } = require('@ifesol/ipc-framework-nodejs');
+
+async function main() {
+    const client = new IPCClient('my_app', {
+        host: 'localhost',
+        port: 8888
+    });
+
+    try {
+        await client.connect();
+        console.log('✅ Connected to Python server!');
+
+        const response = await client.sendRequest('api', {
+            action: 'get_data'
+        });
+
+        console.log('📨 Response from Python:', response.payload);
+    } catch (error) {
+        console.error('❌ Error:', error.message);
+    } finally {
+        client.disconnect();
+    }
+}
+
+main();
+```
+
+## 🎯 **Architecture Features**
+
+### **✅ Production-Ready Server:**
+- **High-performance TCP sockets** for low-latency communication
+- **Hierarchical structure** with applications and channels
+- **Message routing** and automatic connection management
+- **Thread-safe operations** with robust error handling
+
+### **✅ Communication Patterns:**
+- **Request/Response** - Direct client-server communication
+- **Publish/Subscribe** - Real-time notifications and broadcasts
+- **Channel-based routing** - Organized message handling
+- **Connection pooling** - Efficient resource management
+
+## 🏗️ **Integration with Node.js**
+
+This Python server works seamlessly with Node.js applications. Here's how to connect an Express.js app:
+
+**Node.js Express.js Integration:**
+```javascript
+const express = require('express');
+const { IPCClient } = require('@ifesol/ipc-framework-nodejs');
+
+const app = express();
+const pythonClient = new IPCClient('web_api');
+
+app.use(express.json());
+
+// Initialize connection to Python IPC server
+pythonClient.connect().then(() => {
+    console.log('🔗 Connected to Python IPC server');
+});
+
+// API endpoint proxying to Python backend
+app.post('/api/process', async (req, res) => {
+    try {
+        const result = await pythonClient.sendRequest('processing', {
+            action: 'process_user_data',
+            data: req.body,
+            connection_id: pythonClient.connectionId
+        });
+        
+        res.json(result.payload);
+    } catch (error) {
+        res.status(500).json({ error: error.message });
+    }
+});
+
+app.listen(3000, () => {
+    console.log('🌐 Express server running on port 3000');
+    console.log('📡 Proxying requests to Python IPC server');
+});
+```
+
+## 📊 **Performance Characteristics**
+
+| Feature | Performance | Details |
+|---------|-------------|---------|
+| **Connection Handling** | Sub-millisecond | Fast TCP connection establishment |
+| **Message Processing** | <1ms latency | Direct socket communication |
+| **Concurrent Connections** | 100+ clients | Thread-safe connection management |
+| **Message Throughput** | High-volume | Efficient message routing |
+| **Memory Usage** | Low footprint | Optimized Python implementation |
+| **Error Recovery** | Automatic | Robust connection cleanup |
+
+## 🎯 **Use Cases**
+
+This Python IPC server enables powerful hybrid architectures:
+
+### **Backend Services**
+- **AI/ML model serving** - Host machine learning models and serve predictions to Node.js frontends
+- **Data processing pipelines** - Heavy computational tasks handled by Python, coordinated with Node.js
+- **Real-time analytics** - Python analytics engines feeding real-time dashboards
+- **Scientific computing** - NumPy/SciPy computations accessible from Node.js applications
+
+### **Microservice Architecture**
+- **Polyglot microservices** - Python services integrated with Node.js API gateways
+- **Event-driven architecture** - Python services publishing events to Node.js consumers
+- **Service mesh integration** - Python backend services in cloud-native environments
+- **Legacy system integration** - Bridge existing Python systems with modern Node.js frontends
+
+### **Hybrid Applications**
+- **E-commerce platforms** - Python inventory/pricing engines with Node.js storefronts
+- **Financial services** - Python quantitative analysis with Node.js trading interfaces
+- **IoT platforms** - Python device controllers with Node.js monitoring dashboards
+- **Chat applications** - Python NLP processing with Node.js real-time messaging
+
+## 🆚 **Why Choose IPC over HTTP?**
+
+| HTTP API Approach | IPC Framework |
+|-------------------|---------------|
+| ❌ High latency overhead | ✅ Direct TCP communication |
+| ❌ Request/response only | ✅ Request/response + pub/sub |
+| ❌ Manual connection management | ✅ Automatic reconnection |
+| ❌ Complex error handling | ✅ Built-in fault tolerance |
+| ❌ No real-time capabilities | ✅ Live notifications |
+| ❌ Stateless limitations | ✅ Persistent connections |
+
+## 🔗 **Companion Packages**
+
+This Python server works with the Node.js client package:
+
+- **Node.js Client**: [@ifesol/ipc-framework-nodejs](https://www.npmjs.com/package/@ifesol/ipc-framework-nodejs) - Production-ready TCP client
+- **Installation**: `npm install @ifesol/ipc-framework-nodejs`
+- **Documentation**: [Node.js Package Docs](https://www.npmjs.com/package/@ifesol/ipc-framework-nodejs)
+
+## 🚀 **Getting Started**
+
+1. **Install the Python server:**
+   ```bash
+   pip install ipc-framework
+   ```
+
+2. **Install the Node.js client:**
+   ```bash
+   npm install @ifesol/ipc-framework-nodejs
+   ```
+
+3. **Run the examples above** to see the integration in action!
+
+## 📚 **Documentation**
+
+- [Python API Reference](https://github.com/ifesol/ipc-framework#python-api)
+- [Node.js Client Usage](https://www.npmjs.com/package/@ifesol/ipc-framework-nodejs)
+- [Integration Examples](https://github.com/ifesol/ipc-framework/tree/main/examples)
+
+## 📄 License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## 🤝 Contributing
+
+Contributions welcome! Help us improve the Python ↔ Node.js IPC communication experience.