=================
django-watchfiles
=================
Use `watchfiles <https://watchfiles.helpmanual.io/>`__ in Django’s autoreloader.
Requirements
------------
Python 3.7 to 3.10 supported.
Django 2.2 to 4.0 supported.
Installation
------------
1. Install with **pip**:
.. code-block:: sh
python -m pip install django-watchfiles
2. Add django-watchfiles to your ``INSTALLED_APPS``:
.. code-block:: python
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:
.. code-block:: shell
$ ./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``.
Raw data
{
"_id": null,
"home_page": "https://github.com/adamchainz/django-watchfiles",
"name": "makavafal-django-watchfiles",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Adam Johnson",
"author_email": "me@adamj.eu",
"download_url": "https://files.pythonhosted.org/packages/6b/84/8ab47ffd8c4bd0afe70745c5a2cb35f11bf1d776f417d7444e11f7b0e177/makavafal-django-watchfiles-0.0.1.tar.gz",
"platform": null,
"description": "=================\ndjango-watchfiles\n=================\n\nUse `watchfiles <https://watchfiles.helpmanual.io/>`__ in Django\u2019s autoreloader.\n\nRequirements\n------------\n\nPython 3.7 to 3.10 supported.\n\nDjango 2.2 to 4.0 supported.\n\nInstallation\n------------\n\n1. Install with **pip**:\n\n .. code-block:: sh\n\n python -m pip install django-watchfiles\n\n2. Add django-watchfiles to your ``INSTALLED_APPS``:\n\n .. code-block:: python\n\n INSTALLED_APPS = [\n ...,\n \"django_watchfiles\",\n ...,\n ]\n\nThat\u2019s it! \ud83d\ude05\n\nDjango doesn\u2019t provide an official API for alternative autoreloader classes.\nTherefore, django-watchfiles monkey-patches ``django.utils.autoreload`` to make its own reloader the only available class.\nYou can tell it is installed as ``runserver`` will list ``WatchfilesReloader`` as in use:\n\n.. code-block:: shell\n\n $ ./manage.py runserver\n Watching for file changes with WatchfilesReloader\n ...\n\nUnlike Django\u2019s built-in ``WatchmanReloader``, there is no need for a fallback to ``StatReloader``, since ``watchfiles`` implements its own internal fallback to using ``stat``.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Use watchfiles in Django\u2019s autoreloader.",
"version": "0.0.1",
"project_urls": {
"Changelog": "https://github.com/adamchainz/django-watchfiles/blob/main/HISTORY.rst",
"Homepage": "https://github.com/adamchainz/django-watchfiles",
"Twitter": "https://twitter.com/adamchainz"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "970cf88e942424d7a98eb594dbf11e28fbb7d31633888d9e3b38df7925e19d8d",
"md5": "e6fabb74d61cb79ec9eb3ae57d515553",
"sha256": "f3b399397faf2f50a7be986180d985a9b8e8395053f9d7297b8f77bd00c27a53"
},
"downloads": -1,
"filename": "makavafal_django_watchfiles-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6fabb74d61cb79ec9eb3ae57d515553",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2980,
"upload_time": "2023-05-30T08:36:27",
"upload_time_iso_8601": "2023-05-30T08:36:27.793213Z",
"url": "https://files.pythonhosted.org/packages/97/0c/f88e942424d7a98eb594dbf11e28fbb7d31633888d9e3b38df7925e19d8d/makavafal_django_watchfiles-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6b848ab47ffd8c4bd0afe70745c5a2cb35f11bf1d776f417d7444e11f7b0e177",
"md5": "697ef9442e66bf923b6998ac83db1f43",
"sha256": "00d197ed04543bf2270f9ff8b50c433e03fe30d6282b81f14eeab27e1a1b5728"
},
"downloads": -1,
"filename": "makavafal-django-watchfiles-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "697ef9442e66bf923b6998ac83db1f43",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 3392,
"upload_time": "2023-05-30T08:36:29",
"upload_time_iso_8601": "2023-05-30T08:36:29.208787Z",
"url": "https://files.pythonhosted.org/packages/6b/84/8ab47ffd8c4bd0afe70745c5a2cb35f11bf1d776f417d7444e11f7b0e177/makavafal-django-watchfiles-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-30 08:36:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adamchainz",
"github_project": "django-watchfiles",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "makavafal-django-watchfiles"
}
JSON
