pylogue 0.1.0__tar.gz

pylogue-0.1.0/AUTHORS.md

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Yeshwanth Reddy <yyeshr@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

pylogue-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,136 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome, and they are greatly appreciated! Every little bit
+helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/sizhky/pylogue/issues.
+
+If you are reporting a bug, please include:
+
+* Your operating system name and version.
+* Any details about your local setup that might be helpful in troubleshooting.
+* Detailed steps to reproduce the bug.
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
+wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Write Documentation
+~~~~~~~~~~~~~~~~~~~
+
+Pylogue could always use more documentation, whether as part of the
+official Pylogue docs, in docstrings, or even on the web in blog posts,
+articles, and such.
+
+Submit Feedback
+~~~~~~~~~~~~~~~
+
+The best way to send feedback is to file an issue at https://github.com/sizhky/pylogue/issues.
+
+If you are proposing a feature:
+
+* Explain in detail how it would work.
+* Keep the scope as narrow as possible, to make it easier to implement.
+* Remember that this is a volunteer-driven project, and that contributions
+  are welcome :)
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `pylogue` for local development.
+
+1. Fork the `pylogue` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_name_here/pylogue.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv pylogue
+    $ cd pylogue/
+    $ python setup.py develop
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the
+   tests, including testing other Python versions with tox::
+
+    $ make lint
+    $ make test
+    Or
+    $ make test-all
+
+   To get flake8 and tox, just pip install them into your virtualenv.
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+Pull Request Guidelines
+-----------------------
+
+Before you submit a pull request, check that it meets these guidelines:
+
+1. The pull request should include tests.
+2. If the pull request adds functionality, the docs should be updated. Put
+   your new functionality into a function with a docstring, and add the
+   feature to the list in README.rst.
+3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
+   https://travis-ci.com/sizhky/pylogue/pull_requests
+   and make sure that the tests pass for all supported Python versions.
+
+Tips
+----
+
+To run a subset of tests::
+
+$ pytest tests.test_pylogue
+
+Deploying
+---------
+
+A reminder for the maintainers on how to deploy.
+Make sure all your changes are committed (including an entry in HISTORY.rst).
+Then run::
+
+$ bump2version patch # possible: major / minor / patch
+$ git push
+$ git push --tags
+
+Travis will then deploy to PyPI if tests pass.
+
+Code of Conduct
+---------------
+
+Please note that this project is released with a `Contributor Code of Conduct`_.
+By participating in this project you agree to abide by its terms.
+
+.. _`Contributor Code of Conduct`: CODE_OF_CONDUCT.rst

pylogue-0.1.0/MANIFEST.in

@@ -0,0 +1,11 @@
+include AUTHORS.md
+include CONTRIBUTING.md
+include LICENSE
+include README.md
+
+recursive-include tests *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-exclude docs
+recursive-include Makefile make.bat *.jpg *.png *.gif

pylogue-0.1.0/PKG-INFO

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: pylogue
+Version: 0.1.0
+Summary: A Chatbot UI build for Pydantic-AI agents
+Author-email: Yeshwanth Reddy <yyeshr@gmail.com>
+Maintainer-email: Yeshwanth Reddy <yyeshr@gmail.com>
+License: MIT license
+Project-URL: bugs, https://github.com/sizhky/pylogue/issues
+Project-URL: changelog, https://github.com/sizhky/pylogue/blob/master/changelog.md
+Project-URL: homepage, https://github.com/sizhky/pylogue
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.md
+Requires-Dist: typer
+Requires-Dist: nbdev
+Requires-Dist: mkdocs-material>=9.6.18
+Requires-Dist: mkdocs-mermaid2-plugin>=1.2.1
+Requires-Dist: mkdocs-awesome-pages-plugin>=2.10.1
+Requires-Dist: mkdocs-minify-plugin>=0.8.0
+Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.4.7
+Requires-Dist: pymdown-extensions>=10.16.1
+Requires-Dist: python-fasthtml>=0.12.29
+Provides-Extra: dev
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file

pylogue-0.1.0/README.md

@@ -0,0 +1,269 @@
+# Pylogue - Full DI Chat Framework
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## 🚀 Quick Start
+
+### Minimal Example (5 lines)
+
+``` python
+from pylogue.chatapp import create_default_chat_app
+
+async def my_responder(msg: str, context=None) -> str:
+    return f"You said: {msg}"
+
+app = create_default_chat_app(responder=my_responder)
+app.run(port=5001)
+```
+
+### Custom Styling
+
+``` python
+from pylogue.card import ChatCard
+from pylogue.chatapp import create_default_chat_app, ChatAppConfig
+
+card = ChatCard(
+    user_color="#1a3a1a",
+    assistant_color="#1a1a3a",
+    user_emoji="👤",
+    assistant_emoji="🤖"
+)
+
+config = ChatAppConfig(
+    app_title="My Assistant",
+    bg_color="#0a0a0a"
+)
+
+app = create_default_chat_app(
+    responder=my_responder,
+    card=card,
+    config=config
+)
+```
+
+## 🎨 Full DI Example
+
+Complete control with dependency injection:
+
+``` python
+from pylogue.chatapp import ChatApp, ChatAppConfig
+from pylogue.session import InMemorySessionManager
+from pylogue.service import ChatService
+from pylogue.renderer import ChatRenderer
+from pylogue.card import ChatCard
+
+# 1. Configure components
+session_manager = InMemorySessionManager()
+
+chat_service = ChatService(
+    responder=my_responder,
+    context_provider=lambda s: s.get_messages()
+)
+
+renderer = ChatRenderer(
+    card=ChatCard(user_color="#2a2a2a")
+)
+
+config = ChatAppConfig(
+    app_title="Custom App"
+)
+
+# 2. Compose application
+app = ChatApp(
+    session_manager=session_manager,
+    chat_service=chat_service,
+    renderer=renderer,
+    config=config
+)
+
+# 3. Run
+app.run(port=5001)
+```
+
+## 🔌 Extensibility
+
+### Custom Session Storage
+
+``` python
+from pylogue.session import SessionManager
+
+class RedisSessionManager(SessionManager):
+    def __init__(self, redis_client):
+        self.redis = redis_client
+    
+    def create_session(self, session_id, initial_messages):
+        # Store in Redis
+        pass
+    
+    def get_session(self, session_id):
+        # Retrieve from Redis
+        pass
+```
+
+### Custom Responder (AI/LLM)
+
+``` python
+class OpenAIResponder:
+    def __init__(self, api_key, model="gpt-4"):
+        self.client = OpenAI(api_key=api_key)
+        self.model = model
+    
+    async def __call__(self, message: str, context=None) -> str:
+        # Call OpenAI API
+        response = await self.client.chat.completions.create(
+            model=self.model,
+            messages=[{"role": "user", "content": message}]
+        )
+        return response.choices[0].message.content
+```
+
+### Custom Error Handler
+
+``` python
+class SlackErrorHandler:
+    def __init__(self, slack_webhook):
+        self.webhook = slack_webhook
+    
+    def __call__(self, error: Exception, message: str) -> str:
+        # Send to Slack
+        requests.post(self.webhook, json={"text": f"Error: {error}"})
+        return "An error occurred. Team has been notified."
+```
+
+## 🧪 Testing
+
+Each component is independently testable:
+
+``` python
+# Test session management
+from pylogue.session import ChatSession
+
+session = ChatSession("test-id")
+session.add_message("User", "Hello")
+assert len(session) == 1
+
+# Test service
+from pylogue.service import ChatService
+
+service = ChatService(responder=my_responder)
+response = await service.process_message("Test")
+assert "Test" in response
+
+# Test renderer
+from pylogue.renderer import ChatRenderer
+from pylogue.session import Message
+
+renderer = ChatRenderer()
+messages = [Message(role="User", content="Hi")]
+html = renderer.render_messages(messages)
+# Assert HTML structure
+```
+
+## 📚 Examples
+
+See `6-Examples.ipynb` for complete working examples:
+
+1.  **Echo Bot** - Simplest possible implementation
+2.  **Custom Styled Chat** - UI/UX customization
+3.  **Context-Aware Assistant** - Uses conversation history
+4.  **Code Assistant** - Syntax highlighting support
+5.  **Supply Chain RCA** - Domain-specific implementation
+
+## 🔧 Configuration Options
+
+### ChatAppConfig
+
+``` python
+@dataclass
+class ChatAppConfig:
+    app_title: str = "Chat Application"
+    page_title: str = "Chat"
+    bg_color: str = "#1a1a1a"
+    header_style: str = "..."
+    ws_endpoint: str = "/ws"
+    markdown_enabled: bool = True
+    syntax_highlighting: bool = True
+    highlight_langs: List[str] = [...]
+    spinner_css: Optional[str] = None
+    initial_messages_factory: Optional[Callable] = None
+```
+
+### ChatCard
+
+``` python
+ChatCard(
+    user_color: str = "#DCF8C6",
+    assistant_color: str = "#E6E6E6",
+    user_emoji: str = "🗣️",
+    assistant_emoji: str = "🕵️‍♂️",
+    width: str = "60%",
+    font_size: str = "1.5em",
+    padding: str = "1.25em",
+    border_radius: str = "1em",
+    # ... many more options
+)
+```
+
+## 🎯 Design Principles
+
+1.  **Separation of Concerns**: Each layer has a single responsibility
+2.  **Dependency Injection**: All dependencies are explicit and
+    injectable
+3.  **Protocol-Oriented**: Components communicate via
+    protocols/interfaces
+4.  **Testability**: Every component can be tested in isolation
+5.  **Extensibility**: Easy to swap implementations without changing
+    code
+6.  **Composition over Inheritance**: Build complex apps from simple
+    parts
+
+## 🔄 Migration from Old Code
+
+If you have existing code using global functions:
+
+**Before:**
+
+``` python
+user_messages = {}  # Global state
+
+def render_chat_list(messages):
+    # ...
+    
+def create_chat_app(responder):
+    # Tightly coupled
+```
+
+**After:**
+
+``` python
+app = create_default_chat_app(responder=your_responder)
+# All state management, rendering, and logic handled cleanly
+```
+
+## 📖 Next Steps
+
+1.  Read through the notebooks in order:
+
+    - `2-Session.ipynb` - Understand state management
+    - `3-Service.ipynb` - Learn business logic layer
+    - `4-Renderer.ipynb` - Explore presentation layer
+    - `5-ChatApp.ipynb` - See full integration
+    - `6-Examples.ipynb` - Working examples
+
+2.  Try the examples in `6-Examples.ipynb`
+
+3.  Build your own custom responder
+
+4.  Deploy to production with your preferred hosting
+
+## 🤝 Contributing
+
+This is a fully modular framework. To extend:
+
+1.  Implement the relevant Protocol
+2.  Inject your implementation
+3.  Test independently
+4.  Compose with other components
+
+No need to modify core code!

pylogue-0.1.0/pyproject.toml

@@ -0,0 +1,71 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pylogue"
+version = "0.1.0"
+description = "A Chatbot UI build for Pydantic-AI agents"
+readme = "README.rst"
+authors = [
+  {name = "Yeshwanth Reddy", email = "yyeshr@gmail.com"}
+]
+maintainers = [
+  {name = "Yeshwanth Reddy", email = "yyeshr@gmail.com"}
+]
+classifiers = [
+
+]
+license = {text = "MIT license"}
+dependencies = [
+  "typer",
+  "nbdev",
+  "mkdocs-material>=9.6.18",
+  "mkdocs-mermaid2-plugin>=1.2.1",
+  "mkdocs-awesome-pages-plugin>=2.10.1",
+  "mkdocs-minify-plugin>=0.8.0",
+  "mkdocs-git-revision-date-localized-plugin>=1.4.7",
+  "pymdown-extensions>=10.16.1",
+  "python-fasthtml>=0.12.29",
+]
+
+[project.optional-dependencies]
+dev = [
+    "coverage",  # testing
+    "mypy",  # linting
+    "pytest",  # testing
+    "ruff"  # linting
+]
+
+[project.urls]
+
+bugs = "https://github.com/sizhky/pylogue/issues"
+changelog = "https://github.com/sizhky/pylogue/blob/master/changelog.md"
+homepage = "https://github.com/sizhky/pylogue"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.package-data]
+"*" = ["*.*"]
+
+[project.scripts]
+pylogue = "pylogue:cli"
+
+# Mypy
+# ----
+
+[tool.mypy]
+files = "."
+
+# Use strict defaults
+strict = true
+warn_unreachable = true
+warn_no_return = true
+
+[[tool.mypy.overrides]]
+# Don't require test functions to include types
+module = "tests.*"
+allow_untyped_defs = true
+disable_error_code = "attr-defined"
+

pylogue-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pylogue-0.1.0/src/pylogue/__init__.py

@@ -0,0 +1,16 @@
+"""Top-level package for Pylogue."""
+
+__all__ = [
+    "__version__",
+    "__author__",
+    "__email__",
+    "cli",
+    "health",
+]
+
+__author__ = """Yeshwanth Reddy"""
+__email__ = "yyeshr@gmail.com"
+__version__ = "0.1.0"
+
+from .__pre_init__ import cli
+from .health import *

pylogue-0.1.0/src/pylogue/__pre_init__.py

@@ -0,0 +1,4 @@
+"""Console script for pylogue."""
+import typer
+
+cli = typer.Typer(name="pylogue", help="A Chatbot UI build for Pydantic-AI agents", no_args_is_help=True)