eidosui 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

eidos/tags.py

@@ -1,29 +1,136 @@
-from typing import Optional, Literal, Any, Union
+from typing import Any
+
 import air
+
 from . import styles
 from .utils import stringify
 
 # Define exports for this module
 __all__ = [
     # Custom EidosUI components
-    'Button', 'H1', 'H2', 'H3', 'H4', 'H5', 'H6', 'Body',
+    "Button",
+    "H1",
+    "H2",
+    "H3",
+    "H4",
+    "H5",
+    "H6",
+    "Body",
     # Semantic components with styling
-    'Strong', 'I', 'Small', 'Del', 'Abbr', 'Var', 'Mark', 'Time',
-    'Code', 'Pre', 'Kbd', 'Samp', 'Blockquote', 'Cite', 'Address',
-    'Hr', 'Details', 'Summary', 'Dl', 'Dt', 'Dd', 'Figure', 'Figcaption',
+    "Strong",
+    "I",
+    "Small",
+    "Del",
+    "Abbr",
+    "Var",
+    "Mark",
+    "Time",
+    "Code",
+    "Pre",
+    "Kbd",
+    "Samp",
+    "Blockquote",
+    "Cite",
+    "Address",
+    "Hr",
+    "Details",
+    "Summary",
+    "Dl",
+    "Dt",
+    "Dd",
+    "Figure",
+    "Figcaption",
+    # Table components with styling
+    "Table",
+    "Thead",
+    "Tbody",
+    "Tfoot",
+    "Tr",
+    "Th",
+    "Td",
     # Pass-through HTML tags from air.tags
-    'A', 'Area', 'Article', 'Aside', 'Audio', 'B', 'Base', 'Bdi', 'Bdo', 'Br',
-    'Canvas', 'Caption', 'Col', 'Colgroup', 'Data', 'Datalist', 'Dfn', 'Dialog', 'Div',
-    'Em', 'Embed', 'Fieldset', 'Footer', 'Form', 'Head', 'Header', 'Hgroup', 'Html',
-    'Iframe', 'Img', 'Input', 'Ins', 'Label', 'Legend', 'Li', 'Link',
-    'Main', 'Map', 'Menu', 'Meta', 'Meter', 'Nav', 'Noscript', 'Object', 'Ol', 'Optgroup', 'Option', 'Output',
-    'P', 'Param', 'Picture', 'Progress', 'Q', 'Rp', 'Rt', 'Ruby',
-    'S', 'Script', 'Search', 'Section', 'Select', 'Source', 'Span', 'Style', 'Sub', 'Sup',
-    'Table', 'Tbody', 'Td', 'Template', 'Textarea', 'Tfoot', 'Th', 'Thead', 'Title', 'Tr', 'Track',
-    'U', 'Ul', 'Video', 'Wbr'
+    "A",
+    "Area",
+    "Article",
+    "Aside",
+    "Audio",
+    "B",
+    "Base",
+    "Bdi",
+    "Bdo",
+    "Br",
+    "Canvas",
+    "Caption",
+    "Col",
+    "Colgroup",
+    "Data",
+    "Datalist",
+    "Dfn",
+    "Dialog",
+    "Div",
+    "Em",
+    "Embed",
+    "Fieldset",
+    "Footer",
+    "Form",
+    "Head",
+    "Header",
+    "Hgroup",
+    "Html",
+    "Iframe",
+    "Img",
+    "Input",
+    "Ins",
+    "Label",
+    "Legend",
+    "Li",
+    "Link",
+    "Main",
+    "Map",
+    "Menu",
+    "Meta",
+    "Meter",
+    "Nav",
+    "Noscript",
+    "Object",
+    "Ol",
+    "Optgroup",
+    "Option",
+    "Output",
+    "P",
+    "Param",
+    "Picture",
+    "Progress",
+    "Q",
+    "Rp",
+    "Rt",
+    "Ruby",
+    "S",
+    "Script",
+    "Search",
+    "Section",
+    "Select",
+    "Source",
+    "Span",
+    "Style",
+    "Sub",
+    "Sup",
+    "Template",
+    "Textarea",
+    "Title",
+    "Track",
+    "U",
+    "Ul",
+    "Video",
+    "Wbr",
 ]
 
-def Button(*content: Any, class_: Optional[Union[str, list[str]]] = styles.buttons.primary, **kwargs: Any) -> air.Tag:
+
+def Button(
+    *content: Any,
+    class_: str | list[str] | None = styles.buttons.primary,
+    **kwargs: Any,
+) -> air.Tag:
     """
     Args:
         content: The content of the button.
@@ -38,7 +145,8 @@ def Button(*content: Any, class_: Optional[Union[str, list[str]]] = styles.butto
     """
     return air.Button(*content, class_=stringify(styles.buttons.base, class_), **kwargs)
 
-def H1(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def H1(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     """
     Args:
         content: The content of the h1 tag.
@@ -53,7 +161,8 @@ def H1(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs:
     """
     return air.H1(*content, class_=stringify(styles.typography.h1, class_), **kwargs)
 
-def H2(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def H2(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     """
     Args:
         content: The content of the h2 tag.
@@ -68,7 +177,8 @@ def H2(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs:
     """
     return air.H2(*content, class_=stringify(styles.typography.h2, class_), **kwargs)
 
-def H3(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def H3(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     """
     Args:
         content: The content of the h3 tag.
@@ -83,33 +193,43 @@ def H3(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs:
     """
     return air.H3(*content, class_=stringify(styles.typography.h3, class_), **kwargs)
 
-def H4(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def H4(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.H4(*content, class_=stringify(styles.typography.h4, class_), **kwargs)
 
-def H5(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def H5(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.H5(*content, class_=stringify(styles.typography.h5, class_), **kwargs)
 
-def H6(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def H6(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.H6(*content, class_=stringify(styles.typography.h6, class_), **kwargs)
 
-def Body(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Body(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Body(*content, class_=stringify(styles.Theme.body, class_), **kwargs)
 
+
 # Semantic HTML Elements
 
-def Strong(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Strong(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Strong(*content, class_=stringify(styles.semantic.strong, class_), **kwargs)
 
-def I(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def I(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.I(*content, class_=stringify(styles.semantic.i, class_), **kwargs)
 
-def Small(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Small(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Small(*content, class_=stringify(styles.semantic.small, class_), **kwargs)
 
-def Del(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Del(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Del(*content, class_=stringify(styles.semantic.del_, class_), **kwargs)
 
-def Abbr(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Abbr(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     """
     Args:
         content: The content of the abbr tag.
@@ -124,71 +244,192 @@ def Abbr(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs
     """
     return air.Abbr(*content, class_=stringify(styles.semantic.abbr, class_), **kwargs)
 
-def Var(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Var(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Var(*content, class_=stringify(styles.semantic.var, class_), **kwargs)
 
-def Mark(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Mark(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Mark(*content, class_=stringify(styles.semantic.mark, class_), **kwargs)
 
-def Time(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Time(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Time(*content, class_=stringify(styles.semantic.time, class_), **kwargs)
 
-def Code(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Code(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Code(*content, class_=stringify(styles.semantic.code, class_), **kwargs)
 
-def Pre(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Pre(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Pre(*content, class_=stringify(styles.semantic.pre, class_), **kwargs)
 
-def Kbd(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Kbd(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Kbd(*content, class_=stringify(styles.semantic.kbd, class_), **kwargs)
 
-def Samp(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Samp(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Samp(*content, class_=stringify(styles.semantic.samp, class_), **kwargs)
 
-def Blockquote(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Blockquote(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Blockquote(*content, class_=stringify(styles.semantic.blockquote, class_), **kwargs)
 
-def Cite(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Cite(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Cite(*content, class_=stringify(styles.semantic.cite, class_), **kwargs)
 
-def Address(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Address(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Address(*content, class_=stringify(styles.semantic.address, class_), **kwargs)
 
-def Hr(class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Hr(class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Hr(class_=stringify(styles.semantic.hr, class_), **kwargs)
 
-def Details(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Details(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Details(*content, class_=stringify(styles.semantic.details, class_), **kwargs)
 
-def Summary(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Summary(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Summary(*content, class_=stringify(styles.semantic.summary, class_), **kwargs)
 
-def Dl(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Dl(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Dl(*content, class_=stringify(styles.semantic.dl, class_), **kwargs)
 
-def Dt(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Dt(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Dt(*content, class_=stringify(styles.semantic.dt, class_), **kwargs)
 
-def Dd(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Dd(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Dd(*content, class_=stringify(styles.semantic.dd, class_), **kwargs)
 
-def Figure(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Figure(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Figure(*content, class_=stringify(styles.semantic.figure, class_), **kwargs)
 
-def Figcaption(*content: Any, class_: Optional[Union[str, list[str]]] = None, **kwargs: Any) -> air.Tag:
+
+def Figcaption(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
     return air.Figcaption(*content, class_=stringify(styles.semantic.figcaption, class_), **kwargs)
 
 
+# Table elements with styling
+
+
+def Table(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
+    """Styled table element."""
+    return air.Table(*content, class_=stringify(styles.tables.table, class_), **kwargs)
+
+
+def Thead(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
+    """Styled table head element."""
+    return air.Thead(*content, class_=stringify(styles.tables.thead, class_), **kwargs)
+
+
+def Tbody(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
+    """Styled table body element."""
+    return air.Tbody(*content, class_=stringify(styles.tables.tbody, class_), **kwargs)
+
+
+def Tfoot(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
+    """Styled table footer element."""
+    return air.Tfoot(*content, class_=stringify(styles.tables.tfoot, class_), **kwargs)
+
+
+def Tr(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
+    """Styled table row element."""
+    return air.Tr(*content, class_=stringify(styles.tables.tr, class_), **kwargs)
+
+
+def Th(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
+    """Styled table header cell element."""
+    return air.Th(*content, class_=stringify(styles.tables.th, class_), **kwargs)
+
+
+def Td(*content: Any, class_: str | list[str] | None = None, **kwargs: Any) -> air.Tag:
+    """Styled table data cell element."""
+    return air.Td(*content, class_=stringify(styles.tables.td, class_), **kwargs)
+
+
 # Pass-through tags from air.tags
 # Import all standard HTML tags that don't have custom styling
 from air.tags import (
-    A, Area, Article, Aside, Audio, B, Base, Bdi, Bdo, Br,
-    Canvas, Caption, Col, Colgroup, Data, Datalist, Dfn, Dialog, Div,
-    Em, Embed, Fieldset, Footer, Form, Head, Header, Hgroup, Html,
-    Iframe, Img, Input, Ins, Label, Legend, Li, Link,
-    Main, Map, Menu, Meta, Meter, Nav, Noscript, Object, Ol, Optgroup, Option, Output,
-    P, Param, Picture, Progress, Q, Rp, Rt, Ruby,
-    S, Script, Search, Section, Select, Source, Span, Style, Sub, Sup,
-    Table, Tbody, Td, Template, Textarea, Tfoot, Th, Thead, Title, Tr, Track,
-    U, Ul, Video, Wbr
-)
+    A,
+    Area,
+    Article,
+    Aside,
+    Audio,
+    B,
+    Base,
+    Bdi,
+    Bdo,
+    Br,
+    Canvas,
+    Caption,
+    Col,
+    Colgroup,
+    Data,
+    Datalist,
+    Dfn,
+    Dialog,
+    Div,
+    Em,
+    Embed,
+    Fieldset,
+    Footer,
+    Form,
+    Head,
+    Header,
+    Hgroup,
+    Html,
+    Iframe,
+    Img,
+    Input,
+    Ins,
+    Label,
+    Legend,
+    Li,
+    Link,
+    Main,
+    Map,
+    Menu,
+    Meta,
+    Meter,
+    Nav,
+    Noscript,
+    Object,
+    Ol,
+    Optgroup,
+    Option,
+    Output,
+    P,
+    Param,
+    Picture,
+    Progress,
+    Q,
+    Rp,
+    Rt,
+    Ruby,
+    S,
+    Script,
+    Search,
+    Section,
+    Select,
+    Source,
+    Span,
+    Style,
+    Sub,
+    Sup,
+    Template,
+    Textarea,
+    Title,
+    Track,
+    U,
+    Ul,
+    Video,
+    Wbr,
+)

eidos/utils.py

@@ -1,32 +1,30 @@
 """Core utility functions for EidosUI."""
 
-from typing import Optional, Union, List
-import os
-import sys
+from pathlib import Path
 
 
-def stringify(*classes: Optional[Union[str, List[str]]]) -> str:
+def stringify(*classes: str | list[str] | None) -> str:
     """
     Concatenate CSS classes, filtering out None values and flattening lists.
-    
+
     Args:
         *classes: Variable number of class strings, lists of strings, or None values
-        
+
     Returns:
         A single space-separated string of CSS classes
-        
+
     Examples:
         >>> stringify("btn", "btn-primary")
         "btn btn-primary"
-        
+
         >>> stringify("btn", None, "btn-lg")
         "btn btn-lg"
-        
+
         >>> stringify(["btn", "btn-primary"], "mt-4")
         "btn btn-primary mt-4"
     """
-    result = []
-    
+    result: list[str] = []
+
     for class_ in classes:
         if class_ is None:
             continue
@@ -35,38 +33,44 @@ def stringify(*classes: Optional[Union[str, List[str]]]) -> str:
             result.extend(c for c in class_ if c)
         elif isinstance(class_, str) and class_.strip():
             result.append(class_.strip())
-    
+
     return " ".join(result)
 
 
-def get_eidos_static_directory() -> str:
+def get_eidos_static_files(markdown: bool = False) -> dict:
     """
-    Get the path to eidos static files for mounting in FastAPI/Air apps.
-    
-    This function returns the directory containing the eidos package files,
-    which includes the CSS directory. Use this when mounting static files
-    in your application.
-    
+    Get a dictionary mapping URL paths to static file directories.
+
+    This provides a safe way to mount only specific static assets
+    without exposing Python source files.
+
+    Args:
+        markdown: Whether to include markdown plugin CSS (default: False)
+
     Returns:
-        The absolute path to the eidos package directory
-        
+        Dict mapping mount paths to directory paths
+
     Example:
         >>> from fastapi.staticfiles import StaticFiles
-        >>> from eidos.utils import get_eidos_static_directory
-        >>> app.mount("/eidos", StaticFiles(directory=get_eidos_static_directory()), name="eidos")
+        >>> from eidos.utils import get_eidos_static_files
+        >>> # Basic usage - just core CSS and JS
+        >>> for mount_path, directory in get_eidos_static_files().items():
+        ...     app.mount(mount_path, StaticFiles(directory=directory), name=mount_path.strip('/'))
+        >>>
+        >>> # Include markdown CSS
+        >>> for mount_path, directory in get_eidos_static_files(markdown=True).items():
+        ...     app.mount(mount_path, StaticFiles(directory=directory), name=mount_path.strip('/'))
     """
-    try:
-        from importlib.resources import files
-        import pathlib
-        # Convert MultiplexedPath to actual filesystem path
-        eidos_path = files('eidos')
-        if hasattr(eidos_path, '_paths'):
-            # MultiplexedPath - get the first valid path
-            for path in eidos_path._paths:
-                if isinstance(path, pathlib.Path) and path.exists():
-                    return str(path)
-        # Try to get the path directly
-        return str(eidos_path)
-    except (ImportError, AttributeError):
-        # Fallback for development or if importlib.resources fails
-        return os.path.dirname(os.path.abspath(__file__))
+    # Use pathlib for cleaner path handling
+    base_path = Path(__file__).parent.absolute()
+
+    static_files = {
+        "/eidos/css": str(base_path / "css"),
+        "/eidos/js": str(base_path / "js"),
+    }
+
+    # Only include markdown CSS if requested
+    if markdown:
+        static_files["/eidos/plugins/markdown/css"] = str(base_path / "plugins" / "markdown" / "css")
+
+    return static_files

eidosui-0.5.0.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: eidosui
+Version: 0.5.0
+Summary: A modern, Tailwind CSS-based UI library for air development
+Project-URL: Homepage, https://github.com/isaac-flath/EidosUI
+Project-URL: Repository, https://github.com/isaac-flath/EidosUI
+Project-URL: Issues, https://github.com/isaac-flath/EidosUI/issues
+Project-URL: Documentation, https://github.com/isaac-flath/EidosUI#readme
+Author: Isaac Flath
+License-Expression: MIT
+License-File: LICENSE
+Keywords: air,components,css,fastapi,tailwind,ui,web
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: air>=0.12
+Requires-Dist: fastapi[standard]
+Requires-Dist: uvicorn
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: isort; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: markdown
+Requires-Dist: markdown>=3.4; extra == 'markdown'
+Description-Content-Type: text/markdown
+
+# EidosUI
+
+Modern UI library for Python web frameworks. Built on Air and Tailwind CSS.
+
+> [!CAUTION]
+> This library is in alpha, and may have semi-frequent breaking changes.  I'd love for you to try it an contribute feedback or PRs!
+
+## Installation
+
+```bash
+pip install eidosui
+```
+
+## Quick Start
+
+```python
+from eidos import *
+import air
+
+app = air.Air()
+
+@app.get("/")
+def home():
+    return Html(
+        Head(
+            Title("My App"),
+            *EidosHeaders()  # Required CSS/JS
+        ),
+        Body(
+            H1("Welcome"),
+            P("Build modern web apps with Python."),
+            DataTable.from_lists(
+                [["Alice", "30"], ["Bob", "25"]], 
+                headers=["Name", "Age"]
+            )
+        )
+    )
+
+app.run()
+```
+
+## Features
+
+- **Styled HTML tags** - Pre-styled versions of all HTML elements
+- **Components** - DataTable, NavBar, and more  
+- **Themes** - Light/dark themes via CSS variables
+- **Type hints** - Full type annotations
+- **Air integration** - Works seamlessly with Air framework
+
+## Plugins
+
+### Markdown
+
+```bash
+pip install "eidosui[markdown]"
+```
+
+```python
+from eidos.plugins.markdown import Markdown, MarkdownCSS
+
+Head(
+    *EidosHeaders(),
+    MarkdownCSS()  # Add markdown styles
+)
+
+Body(
+    Markdown("# Hello\n\nSupports **GitHub Flavored Markdown**")
+)
+```
+
+## Documentation
+
+Full documentation: https://eidosui.readthedocs.io
+
+## License
+
+MIT