fixed README

Author: NiveditJain

python-sdk/README.md

@@ -1,8 +1,31 @@
 # ExosphereHost Python SDK
-This is the official Python SDK for ExosphereHost and for interacting with ExosphereHost.
 
-## Node Creation
-You can simply connect to exosphere state manager and start creating your nodes, as shown in sample below: 
+[![PyPI version](https://badge.fury.io/py/exospherehost.svg)](https://badge.fury.io/py/exospherehost)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+The official Python SDK for [ExosphereHost](https://exosphere.host) - an open-source infrastructure layer for background AI workflows and agents. This SDK enables you to create distributed, stateful applications using a node-based architecture.
+
+## Overview
+
+ExosphereHost provides a robust, affordable, and effortless infrastructure for building scalable AI workflows and agents. The Python SDK allows you to:
+
+- Create distributed workflows using a simple node-based architecture
+- Build stateful applications that can scale across multiple compute resources
+- Execute complex AI workflows with automatic state management
+- Integrate with the ExosphereHost platform for optimized performance
+
+## Installation
+
+```bash
+pip install exospherehost
+```
+
+## Quick Start
+
+### Basic Node Creation
+
+Create a simple node that processes data:
 
 ```python
 from exospherehost import Runtime, BaseNode
@@ -11,23 +34,124 @@ from pydantic import BaseModel
 class SampleNode(BaseNode):
     class Inputs(BaseModel):
         name: str
+        data: dict
 
     class Outputs(BaseModel):
         message: str
+        processed_data: dict
+
+    async def execute(self) -> Outputs:
+        print(f"Processing data for: {self.inputs.name}")
+        # Your processing logic here
+        processed_data = {"status": "completed", "input": self.inputs.data}
+        return self.Outputs(
+            message="success", 
+            processed_data=processed_data
+        )
+
+# Initialize the runtime
+Runtime(
+    namespace="MyProject", 
+    name="DataProcessor",
+    nodes=[SampleNode]
+).start()
+```
+
+## Environment Configuration
+
+The SDK requires the following environment variables for authentication with ExosphereHost:
+
+```bash
+export EXOSPHERE_STATE_MANAGER_URI="your-state-manager-uri"
+export EXOSPHERE_API_KEY="your-api-key"
+```
+
+## Key Features
+
+- **Distributed Execution**: Run nodes across multiple compute resources
+- **State Management**: Automatic state persistence and recovery
+- **Type Safety**: Full Pydantic integration for input/output validation
+- **Async Support**: Native async/await support for high-performance operations
+- **Error Handling**: Built-in retry mechanisms and error recovery
+- **Scalability**: Designed for high-volume batch processing and workflows
+
+## Architecture
+
+The SDK is built around two core concepts:
+
+### Runtime
+The `Runtime` class manages the execution environment and coordinates with the ExosphereHost state manager. It handles:
+- Node lifecycle management
+- State coordination
+- Error handling and recovery
+- Resource allocation
+
+### Nodes
+Nodes are the building blocks of your workflows. Each node:
+- Defines input/output schemas using Pydantic models
+- Implements an `execute` method for processing logic
+- Can be connected to other nodes to form workflows
+- Automatically handles state persistence
 
-    async def execute(self, inputs: Inputs) -> Outputs:
-        print(inputs)
-        return self.Outputs(message="success")
+## Advanced Usage
 
-# EXOSPHERE_STATE_MANAGER_URI and EXOSPHERE_API_KEY are required to be set in the environment variables for authentication with exospherehost
-runtime = Runtime(
-    namespace="SampleNamespace", 
-    name="SampleNode"
-)
+### Custom Node Configuration
 
-runtime.connect([SampleNode()])
-runtime.start()
+```python
+class ConfigurableNode(BaseNode):
+    class Inputs(BaseModel):
+        text: str
+        max_length: int = 100
+
+    class Outputs(BaseModel):
+        result: str
+        length: int
+
+    async def execute(self) -> Outputs:
+        result = self.inputs.text[:self.inputs.max_length]
+        return self.Outputs(result=result, length=len(result))
 ```
 
+### Error Handling
+
+```python
+class RobustNode(BaseNode):
+    class Inputs(BaseModel):
+        data: str
+
+    class Outputs(BaseModel):
+        success: bool
+        result: str
+
+    async def execute(self) -> Outputs:
+        raise Exception("This is a test error")
+```
+Error handling is automatically handled by the runtime and the state manager.
+
+## Integration with ExosphereHost Platform
+
+The Python SDK integrates seamlessly with the ExosphereHost platform, providing:
+
+- **Cost Optimization**: Leverage ExosphereHost's optimized infrastructure for significant cost savings
+- **Reliability**: Built-in fault tolerance and automatic recovery
+- **Scalability**: Automatic scaling based on workload demands
+- **Monitoring**: Integrated logging and monitoring capabilities
+
+## Documentation
+
+For more detailed information, visit our [documentation](https://docs.exosphere.host).
+
+## Contributing
+
+We welcome contributions! Please see our [contributing guidelines](https://github.com/exospherehost/exospherehost/blob/main/CONTRIBUTING.md) for details.
+
 ## Support
-For first-party support and questions, do not hesitate to reach out to us at <nivedit@exosphere.host>.
+
+For support and questions:
+- **Email**: [nivedit@exosphere.host](mailto:nivedit@exosphere.host)
+- **Documentation**: [https://docs.exosphere.host](https://docs.exosphere.host)
+- **GitHub Issues**: [https://github.com/exospherehost/exospherehost/issues](https://github.com/exospherehost/exospherehost/issues)
+
+## License
+
+This SDK is licensed under the MIT License and the main project is licensend under Elastic License 2.0.