Metadata-Version: 2.2
Name: pyforged
Version: 0.1.0
Summary: The PyForged Ecosytem
Author-email: DirtyWork Solutions Limited <pyforged@open.dirtywork.solutions>
Project-URL: Homepage, https://open.dirtywork.solutions/pyforge
Project-URL: Documentation, https://open.dirtywork.solutions/pyforge/docs
Project-URL: Source, https://github.com/DirtyWork-Solutions/PyForge
Project-URL: Issues, https://github.com/DirtyWork-Solutions/PyForge/tree/main/.github/ISSUE_TEMPLATE
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyutile
Requires-Dist: pyextendable

# PyForge Ecosystem  

**PyForge** is an ecosystem of modular, independent Python packages designed to improve interoperability, efficiency, and rapid prototyping. It provides a comprehensive suite of tools that can be used independently or combined to accelerate development across multiple domains.

## 🚀 Overview  

PyForge is built around the principles of **modularity**, **scalability**, and **extensibility**, ensuring each package serves a well-defined purpose while seamlessly integrating with others. The ecosystem includes utilities for **event-driven architectures, automation, security, data persistence, synchronization, caching, analytics, deployment, and more**.

### 🔹 Why PyForge?  
- **Modular Design** – Use only the packages you need, without unnecessary dependencies.  
- **Interoperability** – Each package is designed to work standalone or as part of a larger system.  
- **Performance-Oriented** – Optimized for concurrency, caching, and efficient execution.  
- **Future-Proof** – Built with extensibility and adaptability in mind.  
- **Enterprise-Ready** – Supports advanced features like security policies, audit logging, and distributed execution.  

---

## 📦 PyForge Packages  

| Package   | Description |
|-----------|------------|
| **PyUtil**  | Core utilities (logging, configuration, caching, exceptions). |
| **PyThings** | Abstraction & management of structured entities. |
| **PyExtend** | Event-driven system, hooks, plugins, and extensibility framework. |
| **PyFlow** | Workflow & state management. |
| **PyGuard** | Security, authentication, & access control. |
| **PyData** | Data persistence & storage abstraction. |
| **PyComms** | Messaging, notifications & event distribution. |
| **PyAgent** | Automation & intelligent action execution. |
| **PySync** | Synchronization & data consistency. |
| **PyCache** | Caching & performance optimization. |
| **PySchema** | Data validation & schema management. |
| **PyMetrics** | Monitoring & analytics. |
| **PyDeploy** | Deployment & DevOps utilities. |
| **PyAudit** | Audit logging & compliance tracking. |

---

## 🔹 Key Features  

### ✅ **Modularity & Extensibility**  
- Packages work independently or together.  
- Extend functionality with plugins, hooks, and dynamic loading.  
- Flexible configuration options (file-based, DB-backed, in-memory).  

### 🔄 **Concurrency & Performance**  
- Async & sync execution for events, hooks, and jobs.  
- Efficient caching mechanisms with **PyCache**.  
- Distributed event & message processing via **PyComms**.  

### 🔐 **Security & Compliance**  
- Access control & authentication through **PyGuard**.  
- Audit logging with **PyAudit** for compliance tracking.  
- Policy-based execution and sandboxing for extensions.  

### 📊 **Observability & Automation**  
- Advanced monitoring & analytics with **PyMetrics**.  
- Workflow automation using **PyAgent** & **PyFlow**.  
- Dynamic synchronization & data consistency via **PySync**.  

---

## ⚡ Installation  

PyForge is designed as a collection of independent packages. You can install them individually as needed:  

```sh
pip install pyutil   # Example: Install PyUtil only
pip install pyextend  # Example: Install PyExtend
```

Or install the full ecosystem:  

```sh
pip install pyforge
```

---

## 🛠 Usage  

### Example 1: Using PyExtend for Event Handling  

```python
from pyextend.events.dispatch import EventDispatcher

dispatcher = EventDispatcher()

def on_custom_event(data):
    print(f"Received event data: {data}")

dispatcher.subscribe("custom_event", on_custom_event)
dispatcher.dispatch("custom_event", {"message": "Hello, PyForge!"})
```

### Example 2: Secure Authentication with PyGuard  

```python
from pyguard.auth import AuthManager

auth = AuthManager()
auth.create_user("admin", "securepassword")

if auth.authenticate("admin", "securepassword"):
    print("Authentication successful!")
```

### Example 3: Caching with PyCache  

```python
from pycache import CacheManager

cache = CacheManager()
cache.set("user_123", {"name": "John Doe", "role": "admin"}, ttl=3600)

user = cache.get("user_123")
print(user)  # Output: {'name': 'John Doe', 'role': 'admin'}
```

---

## 📖 Documentation  

For detailed usage, refer to the official documentation: **[Coming Soon]**  

---

## 🤝 Contributing  

We welcome contributions! To get started:  

1. Fork the repository.  
2. Create a new branch (`feature/my-feature`).  
3. Commit your changes.  
4. Open a pull request.  

Check out the **[contribution guidelines]** for more details.  

---

## 📜 License  

PyForge is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.  

---

## 🔗 Connect & Support  

- Report issues & suggest features via **[GitHub Issues]**  
- Stay updated with releases via **[GitHub Releases]**  
- Join discussions & contribute to development  

🚀 **PyForge – Build Smarter, Faster, & More Securely** 🚀
