azathoth-ui 1.4.0__tar.gz

azathoth_ui-1.4.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Eldritch, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

azathoth_ui-1.4.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: azathoth-ui
+Version: 1.4.0
+Summary: A local editor for Azathoth workflows, served in your browser.
+Author: Eris Discordia Montano
+License: MIT
+Project-URL: Homepage, https://github.com/EldritchInc/azathoth-ui
+Project-URL: Repository, https://github.com/EldritchInc/azathoth-ui
+Keywords: artificial-intelligence,llm,workflow-editor,azathoth
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: azathoth-ai==1.4.*
+Requires-Dist: starlette>=0.40
+Requires-Dist: uvicorn>=0.30
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: httpx; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: setuptools>=68; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Dynamic: license-file
+
+# Azathoth UI
+
+A local editor for [Azathoth](https://github.com/EldritchInc/azathoth)
+workflows, served on your own computer and opened in your browser.
+
+The editor keeps an Azathoth instance of its own, and drives it only through
+Azathoth's public service API, `azathoth.api`, and needs Azathoth 1.4.
+
+## Installing it
+
+Install it into a venv of its own, as
+[Installing Azathoth](https://github.com/EldritchInc/azathoth/blob/main/docs/install.md)
+shows for Azathoth, with Python 3.11 or newer:
+
+```bash
+python -m pip install azathoth-ui
+```
+
+pip brings Azathoth 1.4 with it, from PyPI.
+
+## Running it
+
+```bash
+azathoth-ui
+```
+
+The command creates the editor's own Azathoth instance the first time,
+serves the editor on `127.0.0.1`, and opens it in your browser. It prints the
+address it opened, with a key for this launch; only a browser that has opened
+that address can use the editor. Press Ctrl+C to stop it.
+
+- `--database` edits another Azathoth database, an SQLite file or a
+  PostgreSQL URL. `AZATHOTH_DATABASE` does the same.
+- `--port` listens on one port rather than any free one.
+- `--no-browser` prints the address without opening it.
+
+Providers are configured as they are for Azathoth's own command line, through
+the environment: set `OPENROUTER_API_KEY`, or `AZATHOTH_BEDROCK=1` with your
+AWS credentials, before launching it. The Models page then lists what they
+serve, and keeps the editor's local portfolio, the models its workflows may
+use; a shared server keeps its own
+([ADR 0006](https://github.com/EldritchInc/azathoth-ui/blob/main/docs/adrs/0006-local-models-and-the-portfolio.md)).
+A workflow's Run button runs it on text, JSON or a file, a PDF, an image or
+text, and shows the run as it goes: each step lit on the graph as it starts
+and ends, every event in words, and how it ended. A run goes on if you leave
+its page, and the editor's rail points to the runs still running. Every run
+is kept and listed on its workflow's page, with what each step did. While
+you edit, the editor asks Azathoth what it would refuse and whether the
+workflow could run here, and a step's details try that one step alone, on
+the values you give its inputs, keeping nothing
+([ADR 0007](https://github.com/EldritchInc/azathoth-ui/blob/main/docs/adrs/0007-running-and-watching-workflows.md)).
+The Remotes page names the shared instances your workflows ship to, each
+with the environment variable its token is read from; set it before
+launching the editor, which never sees the token itself. A remote's page
+says where everything stands there, and pulls what it holds that you lack.
+Ship, on every workflow, tool and benchmark, pushes it to a remote after
+saying where it stands, and reports Azathoth's warnings of what would stop
+it running there
+([ADR 0008](https://github.com/EldritchInc/azathoth-ui/blob/main/docs/adrs/0008-shipping-to-a-remote.md)).
+[ADR 0001](https://github.com/EldritchInc/azathoth-ui/blob/main/docs/adrs/0001-local-server-security.md) explains how the server
+keeps other sites and other users out.
+
+## Development
+
+The editor is built against released Azathoth from PyPI: `make install`
+takes the release `pyproject.toml` requires, and never Azathoth's own
+checkout.
+
+The web app needs Node `^20.19.0 || >=22.12.0`, and npm.
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+make install
+make install-web
+make build-web
+make check
+```
+
+`make build-web` builds the web app into the package, where `azathoth-ui`
+serves it. `make check` lints, type-checks and tests both halves: the Python
+package, and the web app with ESLint, Prettier, TypeScript and Vitest. It
+never runs Azathoth's own test suite.
+
+`make wheel` builds the web app, then the wheel with it, into `dist/`.
+Building a wheel refuses until the web app is built.
+
+To work on the web app with hot reloading, start the server on a fixed port,
+open the address it prints once, then start Vite and open
+<http://127.0.0.1:5173>:
+
+```bash
+azathoth-ui --port 8765 --no-browser
+cd web && npm run dev
+```
+
+## License
+
+MIT. See [LICENSE](https://github.com/EldritchInc/azathoth-ui/blob/main/LICENSE).

azathoth_ui-1.4.0/README.md

@@ -0,0 +1,99 @@
+# Azathoth UI
+
+A local editor for [Azathoth](https://github.com/EldritchInc/azathoth)
+workflows, served on your own computer and opened in your browser.
+
+The editor keeps an Azathoth instance of its own, and drives it only through
+Azathoth's public service API, `azathoth.api`, and needs Azathoth 1.4.
+
+## Installing it
+
+Install it into a venv of its own, as
+[Installing Azathoth](https://github.com/EldritchInc/azathoth/blob/main/docs/install.md)
+shows for Azathoth, with Python 3.11 or newer:
+
+```bash
+python -m pip install azathoth-ui
+```
+
+pip brings Azathoth 1.4 with it, from PyPI.
+
+## Running it
+
+```bash
+azathoth-ui
+```
+
+The command creates the editor's own Azathoth instance the first time,
+serves the editor on `127.0.0.1`, and opens it in your browser. It prints the
+address it opened, with a key for this launch; only a browser that has opened
+that address can use the editor. Press Ctrl+C to stop it.
+
+- `--database` edits another Azathoth database, an SQLite file or a
+  PostgreSQL URL. `AZATHOTH_DATABASE` does the same.
+- `--port` listens on one port rather than any free one.
+- `--no-browser` prints the address without opening it.
+
+Providers are configured as they are for Azathoth's own command line, through
+the environment: set `OPENROUTER_API_KEY`, or `AZATHOTH_BEDROCK=1` with your
+AWS credentials, before launching it. The Models page then lists what they
+serve, and keeps the editor's local portfolio, the models its workflows may
+use; a shared server keeps its own
+([ADR 0006](https://github.com/EldritchInc/azathoth-ui/blob/main/docs/adrs/0006-local-models-and-the-portfolio.md)).
+A workflow's Run button runs it on text, JSON or a file, a PDF, an image or
+text, and shows the run as it goes: each step lit on the graph as it starts
+and ends, every event in words, and how it ended. A run goes on if you leave
+its page, and the editor's rail points to the runs still running. Every run
+is kept and listed on its workflow's page, with what each step did. While
+you edit, the editor asks Azathoth what it would refuse and whether the
+workflow could run here, and a step's details try that one step alone, on
+the values you give its inputs, keeping nothing
+([ADR 0007](https://github.com/EldritchInc/azathoth-ui/blob/main/docs/adrs/0007-running-and-watching-workflows.md)).
+The Remotes page names the shared instances your workflows ship to, each
+with the environment variable its token is read from; set it before
+launching the editor, which never sees the token itself. A remote's page
+says where everything stands there, and pulls what it holds that you lack.
+Ship, on every workflow, tool and benchmark, pushes it to a remote after
+saying where it stands, and reports Azathoth's warnings of what would stop
+it running there
+([ADR 0008](https://github.com/EldritchInc/azathoth-ui/blob/main/docs/adrs/0008-shipping-to-a-remote.md)).
+[ADR 0001](https://github.com/EldritchInc/azathoth-ui/blob/main/docs/adrs/0001-local-server-security.md) explains how the server
+keeps other sites and other users out.
+
+## Development
+
+The editor is built against released Azathoth from PyPI: `make install`
+takes the release `pyproject.toml` requires, and never Azathoth's own
+checkout.
+
+The web app needs Node `^20.19.0 || >=22.12.0`, and npm.
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+make install
+make install-web
+make build-web
+make check
+```
+
+`make build-web` builds the web app into the package, where `azathoth-ui`
+serves it. `make check` lints, type-checks and tests both halves: the Python
+package, and the web app with ESLint, Prettier, TypeScript and Vitest. It
+never runs Azathoth's own test suite.
+
+`make wheel` builds the web app, then the wheel with it, into `dist/`.
+Building a wheel refuses until the web app is built.
+
+To work on the web app with hot reloading, start the server on a fixed port,
+open the address it prints once, then start Vite and open
+<http://127.0.0.1:5173>:
+
+```bash
+azathoth-ui --port 8765 --no-browser
+cd web && npm run dev
+```
+
+## License
+
+MIT. See [LICENSE](https://github.com/EldritchInc/azathoth-ui/blob/main/LICENSE).

azathoth_ui-1.4.0/pyproject.toml

@@ -0,0 +1,102 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "azathoth-ui"
+version = "1.4.0"
+description = "A local editor for Azathoth workflows, served in your browser."
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [
+    { name = "Eris Discordia Montano" }
+]
+keywords = [
+    "artificial-intelligence",
+    "llm",
+    "workflow-editor",
+    "azathoth",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed"
+]
+dependencies = [
+    "azathoth-ai==1.4.*",
+    "starlette>=0.40",
+    "uvicorn>=0.30",
+]
+
+[project.scripts]
+azathoth-ui = "azathoth_ui.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/EldritchInc/azathoth-ui"
+Repository = "https://github.com/EldritchInc/azathoth-ui"
+
+[project.optional-dependencies]
+dev = [
+    "build",
+    "httpx",
+    "mypy",
+    "pytest",
+    "ruff",
+    "setuptools>=68",
+    "wheel",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+azathoth_ui = ["py.typed", "assets/*", "static/**/*"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["."]
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "-ra",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"
+src = [".", "src"]
+extend-exclude = ["web"]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "I",
+    "UP",
+    "B",
+    "SIM",
+]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+warn_unreachable = true
+pretty = true
+
+# setuptools ships no types. Only setup.py builds on it: its one command
+# subclasses setuptools' build_py.
+[[tool.mypy.overrides]]
+module = ["setuptools", "setuptools.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["setup"]
+disallow_subclassing_any = false

azathoth_ui-1.4.0/setup.cfg

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

azathoth_ui-1.4.0/setup.py

@@ -0,0 +1,50 @@
+"""The editor's build: everything is in `pyproject.toml`, except one refusal.
+
+A wheel without the web app would install an editor that can only say it is
+not built, so building one refuses until `make build-web` has put the web app
+in `src/azathoth_ui/static`. An editable install, for working on the
+checkout, does not need it.
+"""
+
+from pathlib import Path
+from typing import Final
+
+from setuptools import setup
+from setuptools.command.build_py import build_py
+
+STATIC: Final = Path(__file__).resolve().parent / "src" / "azathoth_ui" / "static"
+"""Where `make build-web` builds the web app into the package."""
+
+
+def require_web_app(
+    static: Path,
+) -> None:
+    """Refuse to build when one folder holds no built web app."""
+
+    index = static / "index.html"
+
+    if not index.is_file():
+        raise SystemExit(
+            f"error: {index} is missing. Run `make build-web` before building the wheel."
+        )
+
+
+class BuildPy(build_py):
+    """`build_py` that refuses to build a wheel without the web app."""
+
+    def needs_web_app(self) -> bool:
+        """Return whether this build makes a wheel, rather than an editable install."""
+
+        return not self.editable_mode
+
+    def run(self) -> None:
+        """Check for the web app, then build as usual."""
+
+        if self.needs_web_app():
+            require_web_app(STATIC)
+
+        super().run()
+
+
+if __name__ == "__main__":
+    setup(cmdclass={"build_py": BuildPy})

azathoth_ui-1.4.0/src/azathoth_ui/__init__.py

@@ -0,0 +1,11 @@
+"""Azathoth's local editor: a web app served on this computer, for this computer.
+
+The editor drives an Azathoth instance of its own through the public service
+API, `azathoth.api`, and never through anything else.
+"""
+
+__version__ = "1.4.0"
+
+__all__ = [
+    "__version__",
+]

azathoth_ui-1.4.0/src/azathoth_ui/__main__.py

@@ -0,0 +1,6 @@
+"""`python -m azathoth_ui`: the `azathoth-ui` command."""
+
+from azathoth_ui.cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())