organize for dist as pypi package

Author: rmorshea

dj_idom/consumers.py

@@ -0,0 +1,60 @@
+from __future__ import annotations
+
+import os
+import re
+import subprocess
+from pathlib import Path
+from typing import List, Tuple
+
+import nox
+from nox.sessions import Session
+
+
+HERE = Path(__file__).parent
+POSARGS_PATTERN = re.compile(r"^(\w+)\[(.+)\]$")
+
+
+@nox.session(reuse_venv=True)
+def format(session: Session) -> None:
+    install_requirements_file(session, "check-style")
+    session.run("black", ".")
+    session.run("isort", ".")
+
+
+@nox.session
+def test(session: Session) -> None:
+    """Run the complete test suite"""
+    session.install("--upgrade", "pip", "setuptools", "wheel")
+    test_suite(session)
+    test_style(session)
+
+
+@nox.session
+def test_suite(session: Session) -> None:
+    """Run the Python-based test suite"""
+    session.env["IDOM_DEBUG_MODE"] = "1"
+    install_requirements_file(session, "test-env")
+    session.install(".[all]")
+    session.run("figure-it-out")
+
+
+@nox.session
+def test_style(session: Session) -> None:
+    """Check that style guidelines are being followed"""
+    install_requirements_file(session, "check-style")
+    session.run("flake8", "src/django_idom", "tests")
+    black_default_exclude = r"\.eggs|\.git|\.hg|\.mypy_cache|\.nox|\.tox|\.venv|\.svn|_build|buck-out|build|dist"
+    session.run(
+        "black",
+        ".",
+        "--check",
+        "--exclude",
+        rf"/({black_default_exclude}|venv|node_modules)/",
+    )
+    session.run("isort", ".", "--check-only")
+
+
+def install_requirements_file(session: Session, name: str) -> None:
+    file_path = HERE / "requirements" / (name + ".txt")
+    assert file_path.exists(), f"requirements file {file_path} does not exist"
+    session.install("-r", str(file_path))

noxfile.py

@@ -0,0 +1,12 @@
+[build-system]
+requires = ["setuptools>=42", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.isort]
+multi_line_output = 3
+force_grid_wrap = 0
+use_parentheses = "True"
+ensure_newline_before_comments = "True"
+include_trailing_comma = "True"
+line_length = 88
+lines_after_imports = 2

pyproject.toml

@@ -1,4 +1,4 @@
-django<4.0.0 # Django Library
-daphne<4.0.0 # Production ASGI webserver
-channels<4.0.0 # Django websocket features
-idom<1.0.0 # Python React
+-r requirements/pkg-deps.txt
+-r requirements/check-style.txt
+-r requirements/test-env.txt
+-r requirements/test-run.txt

requirements.txt

@@ -0,0 +1,3 @@
+black
+flake8
+isort

requirements/check-style.txt

@@ -0,0 +1,2 @@
+channels<4.0.0 # Django websocket features
+idom<1.0.0 # Python React

requirements/pkg-deps.txt

@@ -0,0 +1,2 @@
+django<4.0.0 # Django Library
+daphne<4.0.0 # Production ASGI webserver

requirements/test-env.txt

@@ -0,0 +1 @@
+nox

requirements/test-run.txt

@@ -0,0 +1,11 @@
+[bdist_wheel]
+universal=1
+
+[flake8]
+ignore = E203, E266, E501, W503, F811, N802
+max-line-length = 88
+max-complexity = 18
+select = B,C,E,F,W,T4,B9,N,ROH
+exclude =
+    .eggs/*
+    .nox/*

setup.cfg

@@ -0,0 +1,80 @@
+from pathlib import Path
+
+from setuptools import find_packages, setup
+
+
+# the name of the project
+name = "django_idom"
+
+# basic paths used to gather files
+root_dir = Path(__file__).parent
+src_dir = root_dir / "src"
+package_dir = src_dir / name
+
+
+# -----------------------------------------------------------------------------
+# Package Definition
+# -----------------------------------------------------------------------------
+
+
+package = {
+    "name": name,
+    "python_requires": ">=3.7",
+    "packages": find_packages(str(src_dir)),
+    "package_dir": {"": "src"},
+    "description": "Control the web with Python",
+    "author": "Ryan Morshead",
+    "author_email": "[email protected]",
+    "url": "https://github.com/idom-team/django-idom",
+    "license": "MIT",
+    "platforms": "Linux, Mac OS X, Windows",
+    "keywords": ["interactive", "widgets", "DOM", "React"],
+    "zip_safe": False,
+    "classifiers": [
+        "Framework :: Django",
+        "Framework :: Django :: 3.1",
+        "Framework :: Django :: 3.2",
+        "Operating System :: OS Independent",
+        "Intended Audience :: Developers",
+        "Intended Audience :: Science/Research",
+        "Topic :: Multimedia :: Graphics",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Environment :: Web Environment",
+    ],
+}
+
+
+# -----------------------------------------------------------------------------
+# Requirements
+# -----------------------------------------------------------------------------
+
+
+requirements = []
+with (root_dir / "requirements" / "pkg-deps.txt").open() as f:
+    for line in map(str.strip, f):
+        if not line.startswith("#"):
+            requirements.append(line)
+package["install_requires"] = requirements
+
+
+# -----------------------------------------------------------------------------
+# Library Description
+# -----------------------------------------------------------------------------
+
+
+with (root_dir / "README.md").open() as f:
+    long_description = f.read()
+
+package["long_description"] = long_description
+package["long_description_content_type"] = "text/markdown"
+
+
+# -----------------------------------------------------------------------------
+# Install It
+# -----------------------------------------------------------------------------
+
+
+if __name__ == "__main__":
+    setup(**package)

setup.py

@@ -0,0 +1,3 @@
+from .websocket_consumer import IdomAsyncWebSocketConsumer
+
+__all__ = ["IdomAsyncWebSocketConsumer"]

src/django_idom/__init__.py

@@ -0,0 +1,34 @@
+"""Anything used to construct a websocket endpoint"""
+import asyncio
+from typing import Any
+
+from channels.generic.websocket import AsyncJsonWebsocketConsumer
+
+from idom.core.dispatcher import dispatch_single_view
+from idom.core.component import ComponentConstructor
+
+
+class IdomAsyncWebSocketConsumer(AsyncJsonWebsocketConsumer):
+    """Communicates with the browser to perform actions on-demand."""
+
+    def __init__(
+        self, component_constructor: ComponentConstructor, *args: Any, **kwargs: Any
+    ) -> None:
+        self._idom_component_constructor = component_constructor
+        super().__init__(*args, **kwargs)
+
+    async def connect(self) -> None:
+        self._idom_recv_queue = recv_queue = asyncio.Queue()
+        self._idom_dispatcher_future = dispatch_single_view(
+            self._idom_component_constructor,
+            self.send_json,
+            recv_queue.get,
+        )
+
+    async def close(self, *args: Any, **kwargs: Any) -> None:
+        self._idom_dispatcher_future.cancel()
+        await asyncio.wait([self._idom_dispatcher_future])
+        super().close(*args, **kwargs)
+
+    async def receive_json(self, content: Any, **kwargs: Any) -> None:
+        await self._idom_recv_queue.put(content)

src/django_idom/websocket_consumer.py

@@ -1,8 +1,6 @@
 """
 ASGI config for dj_idom project.
-
 It exposes the ASGI callable as a module-level variable named ``application``.
-
 For more information on this file, see
 https://docs.djangoproject.com/en/3.2/howto/deployment/asgi/
 """
@@ -12,18 +10,18 @@
 from django.conf.urls import url
 from django.core.asgi import get_asgi_application
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "dj_idom.settings")
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.settings")
 
 # Fetch ASGI application before importing dependencies that require ORM models.
 http_asgi_app = get_asgi_application()
 
 from channels.routing import ProtocolTypeRouter, URLRouter
 
-from .consumers import CommandConsumer
+from django_idom import IdomAsyncWebSocketConsumer
 
 application = ProtocolTypeRouter(
     {
         "http": http_asgi_app,
-        "websocket": URLRouter([url("", CommandConsumer().as_asgi())]),
+        "websocket": URLRouter([url("", IdomAsyncWebSocketConsumer().as_asgi())]),
     }
 )

dj_idom/__init__.py renamed to tests/__init__.py

@@ -1,11 +1,8 @@
 """
 Django settings for dj_idom project.
-
 Generated by 'django-admin startproject' using Django 3.2.3.
-
 For more information on this file, see
 https://docs.djangoproject.com/en/3.2/topics/settings/
-
 For the full list of settings and their values, see
 https://docs.djangoproject.com/en/3.2/ref/settings/
 """

dj_idom/asgi.py renamed to tests/asgi.py

@@ -1,17 +1,15 @@
 {% load static %}
 <!DOCTYPE html>
 <html lang="en">
-
-<head>
-    <meta charset="UTF-8">
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <head>
+    <meta charset="UTF-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <script src="{% static 'scripts.js' %}" crossorigin="anonymous"></script>
     <title>IDOM</title>
-</head>
+  </head>
 
-<body>
+  <body>
     <h1>IDOM Test Page</h1>
-</body>
-
-</html>
+  </body>
+</html>

tests/migrations/__init__.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

dj_idom/settings.py renamed to tests/settings.py

@@ -1,5 +1,4 @@
 """dj_idom URL Configuration
-
 The `urlpatterns` list routes URLs to views. For more information please see:
     https://docs.djangoproject.com/en/3.2/topics/http/urls/
 Examples: