simpledomcontrol 0.158.9__tar.gz → 0.160.0__tar.gz

simpledomcontrol-0.160.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-2026 Martin Starman
+
+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.

{simpledomcontrol-0.158.9 → simpledomcontrol-0.160.0}/PKG-INFO

@@ -1,20 +1,23 @@
 Metadata-Version: 2.4
 Name: SimpleDomControl
-Version: 0.158.9
+Version: 0.160.0
 Summary: Simple DOM control -> a django MVC framework
-License: Apache-2.0
+License-Expression: MIT
+License-File: LICENSE
 Keywords: django,MVC
 Author: Martin Starman
 Author-email: private@martin-starman.com
 Requires-Python: >=3.13,<4.0
-Classifier: Environment :: Web Environment
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Framework :: Django
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Environment :: Web Environment
+Classifier: Operating System :: OS Independent
+Provides-Extra: ai
+Provides-Extra: postgres
+Provides-Extra: teach
+Requires-Dist: anthropic (>=2.3.0,<3.0.0) ; extra == "ai"
 Requires-Dist: attrs (>=25.4.0,<26.0.0)
 Requires-Dist: channels (>=4.3.2,<5.0.0)
 Requires-Dist: channels-redis (>=4.3.0,<5.0.0)
@@ -22,16 +25,23 @@ Requires-Dist: click (>=8.1.0)
 Requires-Dist: daphne (>=4.2.1,<5.0.0)
 Requires-Dist: django (>=6.0.2,<7.0.0)
 Requires-Dist: inquirerpy (>=0.3.4,<0.4.0)
-Requires-Dist: poetry-core (>=2.3.1,<3.0.0)
-Requires-Dist: psycopg2-binary (>=2.9.11,<3.0.0)
+Requires-Dist: openai (>=3.41.0,<4.0.0) ; extra == "ai"
+Requires-Dist: playwright (>=1.64.0,<2.0.0) ; extra == "teach"
+Requires-Dist: psycopg2-binary (>=2.9.11,<3.0.0) ; extra == "postgres"
 Requires-Dist: pyjwt (>=2.11.0,<3.0.0)
 Requires-Dist: pyyaml (>=6.0.3,<7.0.0)
 Requires-Dist: regex (>=2026.1.15,<2027.0.0)
-Project-URL: Homepage, https://github.com/StarmanMartin/sdc
+Project-URL: Documentation, https://simpledomcontrol.readthedocs.io/en/latest/
+Project-URL: Homepage, https://github.com/StarmanMartin/SimpleDomControl
+Project-URL: Repository, https://github.com/StarmanMartin/SimpleDomControl
+Project-URL: changelog, https://github.com/StarmanMartin/SimpleDomControl/blob/master/CHANGELOG.md
 Description-Content-Type: text/markdown
 
 # Simple Dom Control (SDC)
 
 SDC is a framework that combines elements of both the MVC (Model-View-Controller) and MVT (Model-View-Template) patterns. Its main goal is to provide a tool for simple and efficient web development. The name ‘SDC’ is an abbreviation for ‘Simple DOM Control,’ indicating its focus on controlling and manipulating the Document Object Model (DOM), which is crucial for web development, particularly in dynamic web pages.
 
+SDC can also describe your UI for AI agents (`manage.py sdc_teach` writes a skill file) and ships an optional
+AI assistant (`<sdc-ai-assistant>`, `pip install "simpledomcontrol[ai]"`) that helps users to use your site.
+
 For detailed docs go to [rtd](https://simpledomcontrol.readthedocs.io/en/latest/)

{simpledomcontrol-0.158.9 → simpledomcontrol-0.160.0}/README.md

@@ -2,4 +2,7 @@
 
 SDC is a framework that combines elements of both the MVC (Model-View-Controller) and MVT (Model-View-Template) patterns. Its main goal is to provide a tool for simple and efficient web development. The name ‘SDC’ is an abbreviation for ‘Simple DOM Control,’ indicating its focus on controlling and manipulating the Document Object Model (DOM), which is crucial for web development, particularly in dynamic web pages.
 
+SDC can also describe your UI for AI agents (`manage.py sdc_teach` writes a skill file) and ships an optional
+AI assistant (`<sdc-ai-assistant>`, `pip install "simpledomcontrol[ai]"`) that helps users to use your site.
+
 For detailed docs go to [rtd](https://simpledomcontrol.readthedocs.io/en/latest/)

simpledomcontrol-0.160.0/pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "SimpleDomControl"
+version = "0.160.0"
+description = "Simple DOM control -> a django MVC framework"
+authors = [{ name = "Martin Starman", email = "private@martin-starman.com" }]
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.13,<4.0"
+keywords = ["django", "MVC"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Framework :: Django",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Environment :: Web Environment",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "daphne (>=4.2.1,<5.0.0)",
+    "channels (>=4.3.2,<5.0.0)",
+    "channels-redis (>=4.3.0,<5.0.0)",
+    "django (>=6.0.2,<7.0.0)",
+    "attrs (>=25.4.0,<26.0.0)",
+    "regex (>=2026.1.15,<2027.0.0)",
+    "click (>=8.1.0)",
+    "pyjwt (>=2.11.0,<3.0.0)",
+    "inquirerpy (>=0.3.4,<0.4.0)",
+    "pyyaml (>=6.0.3,<7.0.0)",
+]
+
+[project.optional-dependencies]
+# PostgreSQL driver: pip install "simpledomcontrol[postgres]"
+postgres = ["psycopg2-binary (>=2.9.11,<3.0.0)"]
+# AI assistant (<sdc-ai-assistant>, SDCAiConsumer): pip install "simpledomcontrol[ai]"
+ai = ["anthropic (>=2.3.0,<3.0.0)", "openai (>=3.41.0,<4.0.0)"]
+# sdc_teach (crawls the UI to write the AI skill file; development only): pip install "simpledomcontrol[teach]"
+teach = ["playwright (>=1.64.0,<2.0.0)"]
+
+[project.urls]
+homepage = "https://github.com/StarmanMartin/SimpleDomControl"
+repository = "https://github.com/StarmanMartin/SimpleDomControl"
+documentation = "https://simpledomcontrol.readthedocs.io/en/latest/"
+changelog = "https://github.com/StarmanMartin/SimpleDomControl/blob/master/CHANGELOG.md"
+
+[project.scripts]
+sdc = "sdc.__main__:cli"
+
+[tool.poetry]
+packages = [{include = "sdc_core"}, {include = "sdc_user"}, {include = "sdc_tools"}, {include = "sdc"}]
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^9.0.2"
+pillow = "^12.1.0"
+sphinx = "^9.1.0"
+sphinx-toolbox = "^4.1.2"
+sphinx-markdown-builder = "^0.6.9"
+sphinx-rtd-theme = "^3.1.0"
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "."
+]
+testpaths = [
+    "pytests",
+]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

simpledomcontrol-0.160.0/sdc/__main__.py

@@ -0,0 +1,92 @@
+"""
+Command line tool of SDC: ``sdc new --name <project>`` creates a new Django project with SDC.
+
+Installed as the console script ``sdc`` (also ``python -m sdc``).
+"""
+import os
+import re
+import shutil
+import subprocess
+import sys
+import venv
+from importlib import metadata
+from pathlib import Path
+
+import click
+
+
+def _default_package():
+    """The simpledomcontrol version of this installation, so the new project uses the same one."""
+    try:
+        return f"simpledomcontrol=={metadata.version('SimpleDomControl')}"
+    except metadata.PackageNotFoundError:
+        return "simpledomcontrol"
+
+
+def _run(cmd, cwd):
+    click.echo(f"$ {' '.join(str(c) for c in cmd)}")
+    result = subprocess.run(cmd, cwd=cwd)
+    if result.returncode != 0:
+        raise click.ClickException(f"Command failed with exit code {result.returncode}: {' '.join(map(str, cmd))}")
+
+
+def _venv_python(venv_dir: Path) -> Path:
+    if os.name == "nt":
+        return venv_dir / "Scripts" / "python.exe"
+    return venv_dir / "bin" / "python"
+
+
+def _add_sdc_core(settings_path: Path):
+    text = settings_path.read_text()
+    if "'sdc_core'" in text or '"sdc_core"' in text:
+        return
+    new_text, count = re.subn(r"INSTALLED_APPS\s*=\s*\[", "INSTALLED_APPS = [\n    'sdc_core',", text, count=1)
+    if count != 1:
+        raise click.ClickException(f"INSTALLED_APPS not found in {settings_path}")
+    settings_path.write_text(new_text)
+
+
+@click.group()
+def cli():
+    pass
+
+
+@cli.command(help="Creates a new SDC project in the subdirectory NAME of the current directory.")
+@click.option("--name", prompt="Project name", help="Name of the new project (a valid Python identifier).")
+@click.option("--package", default=None,
+              help="pip requirement used to install SDC into the project's virtualenv "
+                   "(default: the installed version, e.g. simpledomcontrol==0.160.0).")
+@click.option("--skip-npm", is_flag=True, help="Do not run 'npm install'.")
+def new(name, package, skip_npm):
+    if not name.isidentifier():
+        raise click.BadParameter("The project name must be a valid Python identifier.", param_hint="--name")
+    target = Path.cwd() / name
+    if target.exists() and any(target.iterdir()):
+        raise click.ClickException(f"{target} already exists and is not empty.")
+    target.mkdir(parents=True, exist_ok=True)
+
+    # The virtualenv is created in its final location; moving a virtualenv breaks it.
+    venv_dir = target / "venv"
+    click.echo(f"Creating virtualenv in {venv_dir}")
+    venv.EnvBuilder(with_pip=True).create(venv_dir)
+    python = _venv_python(venv_dir)
+
+    _run([python, "-m", "pip", "install", "--upgrade", "pip"], target)
+    _run([python, "-m", "pip", "install", package or _default_package()], target)
+    _run([python, "-m", "django", "startproject", name, "."], target)
+    _add_sdc_core(target / name / "settings.py")
+    _run([python, "manage.py", "sdc_init", "-y"], target)
+
+    if skip_npm:
+        click.echo("Skipped 'npm install'.")
+    elif shutil.which("npm"):
+        _run(["npm", "install"], target)
+    else:
+        click.echo("npm was not found; run 'npm install' in the project directory to install the client.")
+
+    click.echo(f"\nDone. Next steps:\n  cd {name}\n  source venv/bin/activate\n"
+               f"  python manage.py migrate\n  npm run develop   # in a second terminal: python manage.py runserver")
+
+
+if __name__ == '__main__':
+    cli()

{simpledomcontrol-0.158.9 → simpledomcontrol-0.160.0}/sdc_core/apps.py

@@ -8,7 +8,7 @@ class SdcCoreConfig(AppConfig):
     def ready(self):
         import sys
         from django.conf import settings
-        from sdc_core.signals import set_winner
+        import sdc_core.signals  # noqa: F401 (registers the signal receivers)
 
         if settings.DEBUG and os.path.exists('./Assets'):
             env_vars = {}