dialecto-django

Dialecto's client for Django projects. It has no runtime dependencies and the scan never imports your project.

DIALECTO_SCAN_TOKEN=dlk_… DIALECTO_PROJECT=12 dialecto-django scan --usages

Edit text in place (development only)

Add the middleware under if DEBUG:, run runserver, and open your own pages in Dialecto's editor.

# settings.py
if DEBUG:
    MIDDLEWARE.insert(0, "dialecto_django.middleware.InContextMiddleware")  # first, or just inside GZipMiddleware

Install it as a development dependency (pip install dialecto-django in your dev requirements only). With DEBUG = False, or DIALECTO_IN_CONTEXT=off (an environment variable or a Django setting), Django drops the middleware at load: nothing is patched, no /__dialecto route answers and no marker reaches a page.

• Pages are marked only while Dialecto's editor is open (it heartbeats every 30 s; the flag lapses after 90 s), for a top-level GET of a page on a loopback address. POSTs, JSON, XHR and frames are never marked, and a marked request that returns something other than HTML has the markers stripped.
• Only strings from .po files inside your repository are marked (LOCALE_PATHS and your apps' locale/ folders). Django's and packages' strings, djangojs, and a missing pgettext translation are not.
• Drafts preview in place for plain strings, %(name)s strings (%% is a literal %) and ngettext plurals in any locale; the overlay reads the values off the page and the plural form from the marker. Brace ({name}) and positional (%s) strings, and a page value it cannot read back unambiguously, show "Reload to preview" instead, which renders the draft on the server.
• INSTALLED_APPS += ["dialecto_django"] is optional; it starts the same add-on in AppConfig.ready().
• Settings: DIALECTO_URL, DIALECTO_PROJECT, DIALECTO_PATHS (URL prefixes the add-on is limited to) and DIALECTO_ROOT (the repository folder; default the git top level). A DIALECTO = {...} dict in settings sets the same options by lower-case name.
• With django-csp the add-on adds the Dialecto origin to CONTENT_SECURITY_POLICY directives when it starts. State (drafts, the marking flag) is per process: run one worker. Avoid {% cache %} and cache_page while editing; use DummyCache.
• dialecto-django doctor with DJANGO_SETTINGS_MODULE set checks the middleware position, django-csp, i18n_patterns, the cache backend, --forwarded-allow-ips='*' and worker count.

Settings

Option over environment over default.

CI

- uses: actions/setup-python@v5
  with: { python-version: "3.12" }
- run: pip install dialecto-django
- run: dialecto-django scan --usages
  env:
    DIALECTO_SCAN_TOKEN: ${{ secrets.DIALECTO_SCAN_TOKEN }}
    DIALECTO_PROJECT: "12"

Dialecto reads committed .po files only. .mo files are build output: they are never read, sent or written, so run compilemessages in your own build after a merged Dialecto pull request.

Exit codes