Add initial commit

Author: codingjoe

.editorconfig

@@ -0,0 +1,29 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+max_line_length = 88
+
+[*.{json,yml,yaml,js,jsx,vue,toml}]
+indent_size = 2
+
+[*.{html,htm,svg,xml}]
+indent_size = 2
+max_line_length = 120
+
+[LICENSE]
+insert_final_newline = false
+
+[*.{md,markdown}]
+indent_size = 2
+max_line_length = 80
+
+[Makefile]
+indent_style = tab

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+github: codingjoe
+tidelift: pypi/django-esm
+custom: https://www.paypal.me/codingjoe

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: "/"
+  schedule:
+    interval: daily
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: daily

.github/workflows/ci.yml

@@ -0,0 +1,126 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        lint-command:
+          - bandit -r . -x ./tests
+          - black --check --diff .
+          - flake8 .
+          - isort --check-only --diff .
+          - pydocstyle .
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+          cache: 'pip'
+          cache-dependency-path: 'pyproject.toml'
+      - run: python -m pip install -e .[lint]
+      - run: ${{ matrix.lint-command }}
+
+  dist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - run: python -m pip install --upgrade pip build wheel twine
+      - run: python -m build --sdist --wheel
+      - run: python -m twine check dist/*
+      - uses: actions/upload-artifact@v3
+        with:
+          path: dist/*
+
+  pytest-python:
+    name: PyTest
+    needs:
+      - lint
+    strategy:
+      matrix:
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.12"
+        django-version:
+          - "4.2"  # LTS
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install .[test]
+      - run: python -m pip install django~=${{ matrix.django-version }}.0
+      - run: python -m playwright install
+      - run: python -m pytest
+      - uses: codecov/codecov-action@v3
+        with:
+          flags: py${{ matrix.python-version }}
+
+  pytest-django:
+    name: PyTest
+    needs:
+      - lint
+    strategy:
+      matrix:
+        python-version:
+          - "3.11"
+        django-version:
+          # LTS gets tested on all OS
+          - "3.2"
+          - "4.2"
+          - "5.0"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python -m pip install .[test]
+      - run: python -m pip install django~=${{ matrix.django-version }}.0
+      - run: python -m playwright install
+      - run: python -m pytest
+      - uses: codecov/codecov-action@v3
+        with:
+          flags: dj${{ matrix.django-version }}
+
+  codeql:
+    name: CodeQL
+    needs: [ dist, pytest-python, pytest-django ]
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ python ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          queries: +security-and-quality
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2
+        with:
+          category: "/language:${{ matrix.language }}"

.github/workflows/release.yml

@@ -0,0 +1,21 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  PyPi:
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
+      with:
+        python-version: "3.x"
+    - run: python -m pip install --upgrade pip build wheel twine
+    - run: python -m build --sdist --wheel
+    - run: python -m twine upload dist/*
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }}

.gitignore

@@ -158,3 +158,10 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# flit_scm
+_version.py
+
+# npm
+node_modules/
+package-lock.json

README.md

@@ -1,2 +1,67 @@
-# django-esm
-Lightweight JavaScript ESM module loader for Django.
+# Django ESM
+
+NextGen JavaScript ESM module support for Django.
+
+## Highlights
+
+* easy transition
+* smart cache busting
+* no more bundling
+* native ESM support
+* local vendoring with npm
+
+## Setup
+
+Install the package and add it to your `INSTALLED_APPS` setting:
+
+```bash
+pip install django-esm
+```
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # …
+    'django_esm',
+]
+```
+
+Next, add the node_modules directory to your staticfiles finders:
+
+```python
+# settings.py
+STATICFILES_DIRS = [
+    BASE_DIR / "node_modules",
+]
+```
+
+Finally, add the import map to your base template:
+
+```html
+<!-- base.html -->
+<!DOCTYPE html>
+{% load esm %}
+<html lang="en">
+<head>
+  <script type="importmap">{% importmap %}</script>
+</head>
+</html>
+```
+
+That's it!
+Don't forget to run `npm install` and `python manage.py collectstatic`.
+
+## Usage
+
+You can now import JavaScript modules in your Django templates:
+
+```html
+<!-- index.html -->
+
+{% block content %}
+  <script type="module">
+    import "htmx.org"
+    htmx.logAll()
+  </script>
+{% endblock %}
+```

django_esm/__init__.py

@@ -0,0 +1,6 @@
+"""Lightweight JavaScript ESM module loader for Django."""
+
+from . import _version  # noqa
+
+__version__ = _version.__version__
+VERSION = _version.VERSION_TUPLE

django_esm/templatetags/__init__.py

@@ -0,0 +1,18 @@
+import json
+
+from django import template
+from django.conf import settings
+from django.utils.safestring import mark_safe
+
+from .. import utils
+
+register = template.Library()
+
+
+@register.simple_tag
+def importmap():
+    return mark_safe(  # nosec
+        json.dumps(
+            {"imports": dict(utils.parse_package_json(settings.BASE_DIR))}, indent=2
+        )
+    )