Merge branch 'fix-pypi-readme' into 'main'

Update pypi project description

See merge request wayflow-dev/wayflow-public!336

Author: dhilloulinoracle

wayflowcore/README.md

@@ -1,23 +1,95 @@
-# wayflowcore
+# 🔗 WayFlow Core
 
-This folder and sub-folders contain the code that constitutes the WayFlow Core library.
+[![PyPI - Version](https://img.shields.io/pypi/v/wayflowcore?label=PyPI)](https://pypi.org/project/wayflowcore/#history)
+[![PyPI - License](https://img.shields.io/pypi/l/wayflowcore)](#license)
+[![PyPI - Downloads](https://img.shields.io/pepy/dt/wayflowcore)](https://pypistats.org/packages/wayflowcore)
 
-## Build (recommended)
+**WayFlow Core** is the foundational Python library of the WayFlow ecosystem.
+It provides the runtime engine, abstractions, and components needed to build powerful AI assistants using **Agents**, **Flows**, or hybrid architectures.
 
-Create a Python environment from the root folder.
+WayFlow Core is:
+
+- **🔧 Flexible** — Build assistants using Agents, Flows, or both
+- **🔗 Interoperable** — Works with OCI GenAI, OpenAI, Ollama, and other LLM providers
+- **🧩 Composable** — Encourages modular, reusable building blocks
+- **🚀 Extensible & Open** — Designed for advanced agentic applications
+
+---
+
+## ⚡ Quick Install
 
 ```bash
-$ source ./clean-install-dev.sh
+pip install wayflowcore
+````
+
+(Optional, faster installation using `uv`)
+
+```bash
+pip install uv
+uv pip install wayflowcore
 ```
 
-This will install wayflowcore in editable mode with the dev dependencies.
+---
 
-## Build (module only)
+## 🧠 Quick Start
 
-If you want to install the core module only:
+### 1. Initialize an LLM
 
-```bash
-$ python3 -m venv .venv-wayflowcore
-$ source .venv-wayflowcore/bin/activate
-$ ./install.sh
+Initialize a Large Language Model (LLM) of your choice:
+
+| OCI Gen AI                                                                                                                                                                                                                                                   | Open AI                                                                                                         | Ollama                                                                                                          |
+|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|
+| <pre>from wayflowcore.models import OCIGenAIModel<br><br>llm = OCIGenAIModel(<br>   model_id="provider.model-id",<br>   service_endpoint="https://url-to-service-endpoint.com",<br>   compartment_id="compartment-id",<br>   auth_type="API_KEY",<br>)</pre> | <pre>from wayflowcore.models import OpenAIModel<br><br>llm = OpenAIModel(<br>   model_id="model-id",<br>)</pre> | <pre>from wayflowcore.models import OllamaModel<br><br>llm = OllamaModel(<br>   model_id="model-id",<br>)</pre> |
+
+
+### 2. Create an Assistant
+
+```python
+from wayflowcore.agent import Agent
+
+assistant = Agent(llm=llm)
+
+conversation = assistant.start_conversation()
+conversation.append_user_message("I need help regarding my sql query")
+conversation.execute()
+
+# get the assistant's response to your query
+assistant_answer = conversation.get_last_message()
+assistant_answer.content
+# I'd be happy to help with your SQL query...
 ```
+
+---
+
+## 🧩 What You Can Build
+
+WayFlow Core supports a wide range of agentic patterns:
+
+* 💬 Conversational assistants
+* 🔁 Flow-based assistants with structured sequencing
+* 🤝 Multi-agent systems
+* 🛠️ Tool-calling agents
+* 🧪 Automated code review assistants
+* 📚 Domain-specific knowledge assistants
+
+---
+
+## 💁 Contributing
+
+Contributions are welcome!
+Please refer to the contributor guide located at the root of the repository.
+
+---
+
+## 🔐 Security
+
+For responsibly reporting security issues, please refer to the project's security guidelines.
+
+---
+
+## 📄 License
+
+WayFlow Core is dual-licensed under:
+
+- **Apache License 2.0** – see [`LICENSE-APACHE.txt`](https://github.com/oracle/wayflow/blob/main/LICENSE-APACHE.txt)
+- **Universal Permissive License (UPL) 1.0** – see [`LICENSE-UPL.txt`](https://github.com/oracle/wayflow/blob/main/LICENSE-UPL.txt)

wayflowcore/setup.py

@@ -32,7 +32,7 @@ def read(file_name):
     license="APACHE-2.0 OR UPL-1.0",
     long_description=read("README.md"),
     long_description_content_type="text/markdown",
-    url="",
+    url="https://github.com/oracle/wayflow",
     author="Oracle",
     author_email="",
     classifiers=[
@@ -46,7 +46,7 @@ def read(file_name):
         "Programming Language :: Python :: 3.13",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
-    keywords="NLP, text generation,code generation, LLM, Assistant, Tool, Agent",
+    keywords="NLP, text generation, code generation, LLM, Assistant, Tool, Agent",
     package_dir={"": "src"},
     packages=find_packages("src"),
     python_requires=">=3.10,<3.14",