Skip to main content

Use watchfiles in Django’s autoreloader.

Project description

https://img.shields.io/github/actions/workflow/status/adamchainz/django-watchfiles/main.yml.svg?branch=main&style=for-the-badge https://img.shields.io/badge/Coverage-100%25-success?style=for-the-badge https://img.shields.io/pypi/v/django-watchfiles.svg?style=for-the-badge https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge pre-commit

Use watchfiles in Django’s autoreloader.


Improve your Django and Git skills with my books.


Requirements

Python 3.9 to 3.13 supported.

Django 4.2 to 5.1 supported.

Installation

  1. Install with pip:

    python -m pip install django-watchfiles
  2. Add django-watchfiles to your INSTALLED_APPS:

    INSTALLED_APPS = [
        ...,
        "django_watchfiles",
        ...,
    ]

That’s it! 😅

Django doesn’t provide an official API for alternative autoreloader classes. Therefore, django-watchfiles monkey-patches django.utils.autoreload to make its own reloader the only available class. You can tell it is installed as runserver will list WatchfilesReloader as in use:

$ ./manage.py runserver
Watching for file changes with WatchfilesReloader
...

Unlike Django’s built-in WatchmanReloader, there is no need for a fallback to StatReloader, since watchfiles implements its own internal fallback to using stat.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_watchfiles-1.0.0.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

django_watchfiles-1.0.0-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file django_watchfiles-1.0.0.tar.gz.

File metadata

  • Download URL: django_watchfiles-1.0.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for django_watchfiles-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e4aa8e910bee610dae2b586771e587072fd984fad8a17e83940e707cfe2ca427
MD5 b0e24e8acd1c51669569b6a95bed1164
BLAKE2b-256 0f997783138d516d0ffa9542e1bbbbe7efd30f1c6769745b51e93f9fe456f14e

See more details on using hashes here.

File details

Details for the file django_watchfiles-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_watchfiles-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eaee798f908864f2a0b73d0362867c7d3a284398eaca82a0583b43969a37178d
MD5 6e634bc136c9a813b647f35281ed6e81
BLAKE2b-256 75cb5f478ed62be3b82a4adaaff51b209f9a72413d83449ca1baee9b8e718d59

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page