aioxlib 0.1.0__tar.gz → 0.3.0__tar.gz

aioxlib-0.3.0/PKG-INFO

@@ -0,0 +1,138 @@
+Metadata-Version: 2.4
+Name: aioxlib
+Version: 0.3.0
+Summary: Human friendly interface to XLib subsystems using asyncio python
+Author-email: Jose Tiago Macara Coutinho <coutinhotiago@gmail.com>
+License-Expression: GPL-3.0-or-later
+Project-URL: Documentation, https://aioxlib.readthedocs.io/en/latest/
+Project-URL: Homepage, https://codeberg.org/tiagocoutinho/aioxlib/
+Project-URL: Repository, https://codeberg.org/tiagocoutinho/aioxlib/
+Keywords: x11,asyncio
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Multimedia :: Video :: Capture
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# aioxlib
+
+**Human-friendly asyncio interface to the X11 protocol**
+
+[![PyPI](https://img.shields.io/pypi/v/aioxlib.svg)](https://pypi.org/project/aioxlib/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/aioxlib.svg)](https://pypi.org/project/aioxlib/)
+[![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+`aioxlib` is a pure-Python library that speaks the X11 wire protocol over
+asyncio—without blocking the event loop and without linking to libX11.
+
+## Documentation
+
+- Online: [aioxlib.readthedocs.io](https://aioxlib.readthedocs.io)
+- Local: `pip install -r docs/requirements.txt && mkdocs serve`
+
+## Installation
+
+```bash
+pip install aioxlib
+```
+
+## Quick start
+
+The **root package** exposes the functional API and `get_display` only:
+
+```python
+import asyncio
+import aioxlib
+
+async def main():
+    wnd = await aioxlib.create_window(640, 480, title="Hello from aioxlib")
+    await wnd.show()
+
+    async for event in aioxlib.events():
+        if wnd.is_delete_window(event):
+            break
+
+asyncio.run(main())
+```
+
+### Explicit display (object API)
+
+```python
+import asyncio
+import aioxlib
+
+async def main():
+    display = await aioxlib.get_display()
+    async with display:
+        screen = display.default_screen()
+        wnd = await screen.create_window(640, 480, title="Hello from aioxlib")
+        await wnd.show()
+
+        async for event in display.events():
+            if wnd.is_delete_window(event):
+                break
+
+asyncio.run(main())
+```
+
+## Package layout
+
+| Module | Contents |
+|--------|----------|
+| **`aioxlib`** (root) | Constants/enums + functional API + `get_display` |
+| `aioxlib.constants` | X11 constants and enumerations |
+| `aioxlib.protocol` | Constants, enums, pack/unpack |
+| `aioxlib.connection` | Socket connection, Xauthority |
+| `aioxlib.resource` | Resource, Drawable, ResourceManager |
+| `aioxlib.display` (Window, Screen, GC, …) | Window, Screen, GC |
+| `aioxlib.display` | Display, Pipeline |
+| `aioxlib.render` / `shm` / `dbe` / … | Extensions |
+
+### Root functional API (selection)
+
+| Function | Role |
+|----------|------|
+| `get_display` / `get_default_display` | Open connection |
+| `create_window`, `map_window`, … | Windows |
+| `events()`, `pipeline()` | Event stream / batched writes |
+| `flush`, `query_extension`, `get_atom`, … | Display operations |
+| `close_default_display` | Tear down default connection |
+
+Classes such as `Display`, `Window`, and `EventType` are **not** re-exported
+from the root; import them from their modules.
+
+## Documentation
+
+```bash
+pip install mkdocs mkdocs-material 'mkdocstrings[python]'
+mkdocs serve
+```
+
+## Examples
+
+```bash
+python examples/basic.py
+python examples/functional.py
+```
+
+## Requirements
+
+- Python ≥ 3.12
+- An X11 server and `$DISPLAY` (or an explicit URI)
+
+## License
+
+GPLv3 or later — see [LICENSE](LICENSE).
+
+## Author
+
+José Tiago Macara Coutinho  
+<https://codeberg.org/tiagocoutinho>

aioxlib-0.3.0/README.md

@@ -0,0 +1,114 @@
+# aioxlib
+
+**Human-friendly asyncio interface to the X11 protocol**
+
+[![PyPI](https://img.shields.io/pypi/v/aioxlib.svg)](https://pypi.org/project/aioxlib/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/aioxlib.svg)](https://pypi.org/project/aioxlib/)
+[![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+
+`aioxlib` is a pure-Python library that speaks the X11 wire protocol over
+asyncio—without blocking the event loop and without linking to libX11.
+
+## Documentation
+
+- Online: [aioxlib.readthedocs.io](https://aioxlib.readthedocs.io)
+- Local: `pip install -r docs/requirements.txt && mkdocs serve`
+
+## Installation
+
+```bash
+pip install aioxlib
+```
+
+## Quick start
+
+The **root package** exposes the functional API and `get_display` only:
+
+```python
+import asyncio
+import aioxlib
+
+async def main():
+    wnd = await aioxlib.create_window(640, 480, title="Hello from aioxlib")
+    await wnd.show()
+
+    async for event in aioxlib.events():
+        if wnd.is_delete_window(event):
+            break
+
+asyncio.run(main())
+```
+
+### Explicit display (object API)
+
+```python
+import asyncio
+import aioxlib
+
+async def main():
+    display = await aioxlib.get_display()
+    async with display:
+        screen = display.default_screen()
+        wnd = await screen.create_window(640, 480, title="Hello from aioxlib")
+        await wnd.show()
+
+        async for event in display.events():
+            if wnd.is_delete_window(event):
+                break
+
+asyncio.run(main())
+```
+
+## Package layout
+
+| Module | Contents |
+|--------|----------|
+| **`aioxlib`** (root) | Constants/enums + functional API + `get_display` |
+| `aioxlib.constants` | X11 constants and enumerations |
+| `aioxlib.protocol` | Constants, enums, pack/unpack |
+| `aioxlib.connection` | Socket connection, Xauthority |
+| `aioxlib.resource` | Resource, Drawable, ResourceManager |
+| `aioxlib.display` (Window, Screen, GC, …) | Window, Screen, GC |
+| `aioxlib.display` | Display, Pipeline |
+| `aioxlib.render` / `shm` / `dbe` / … | Extensions |
+
+### Root functional API (selection)
+
+| Function | Role |
+|----------|------|
+| `get_display` / `get_default_display` | Open connection |
+| `create_window`, `map_window`, … | Windows |
+| `events()`, `pipeline()` | Event stream / batched writes |
+| `flush`, `query_extension`, `get_atom`, … | Display operations |
+| `close_default_display` | Tear down default connection |
+
+Classes such as `Display`, `Window`, and `EventType` are **not** re-exported
+from the root; import them from their modules.
+
+## Documentation
+
+```bash
+pip install mkdocs mkdocs-material 'mkdocstrings[python]'
+mkdocs serve
+```
+
+## Examples
+
+```bash
+python examples/basic.py
+python examples/functional.py
+```
+
+## Requirements
+
+- Python ≥ 3.12
+- An X11 server and `$DISPLAY` (or an explicit URI)
+
+## License
+
+GPLv3 or later — see [LICENSE](LICENSE).
+
+## Author
+
+José Tiago Macara Coutinho  
+<https://codeberg.org/tiagocoutinho>

aioxlib-0.3.0/aioxlib/__init__.py

@@ -0,0 +1,34 @@
+#
+# This file is part of the aioxlib project
+#
+# Copyright (c) 2026 Tiago Coutinho
+# Distributed under the GPLv3 license. See LICENSE for more info.
+
+"""Asyncio-native pure-Python X11 client.
+
+The root package exposes **constants/enums** (:mod:`aioxlib.constants`), the
+**functional API** (:mod:`aioxlib.api`), and :func:`get_display` / :func:`get_display_config`.
+
+Types and protocol helpers live in submodules::
+
+    from aioxlib import get_display, create_window, events, EventType, EventMask
+    from aioxlib.display import Display, Window
+    from aioxlib.protocol import pack_create_window
+"""
+
+__version__ = "0.3.0"
+
+from .api import *  # noqa: F403
+from .api import __all__ as _api_all
+from .constants import *  # noqa: F403
+from .constants import __all__ as _constants_all
+from .display import get_display
+
+__all__ = [
+    "__version__",
+    "get_display",
+    *_constants_all,
+    *_api_all,
+]
+
+del _api_all, _constants_all

aioxlib-0.3.0/aioxlib/_extensions.py

@@ -0,0 +1,25 @@
+#
+# This file is part of the aioxlib project
+#
+# Copyright (c) 2026 Tiago Coutinho
+# Distributed under the GPLv3 license. See LICENSE for more info.
+
+from __future__ import annotations
+
+from .bigreq import BigRequests
+from .dbe import DoubleBuffer
+from .dri3 import DRI3
+from .glx import GLX
+from .present import Present
+from .render import Render
+from .shm import SharedMemory
+
+EXTENSIONS = {
+    "MIT-SHM": SharedMemory,
+    "DOUBLE-BUFFER": DoubleBuffer,
+    "BIG-REQUESTS": BigRequests,
+    "GLX": GLX,
+    "DRI3": DRI3,
+    "Present": Present,
+    "RENDER": Render,
+}