https://github.com/Pylons/hupper
in-process file monitor / reloader for reloading your code automatically during development
https://github.com/Pylons/hupper
daemon file-monitoring inotify python reload watchdog
Last synced: about 1 year ago
JSON representation
in-process file monitor / reloader for reloading your code automatically during development
- Host: GitHub
- URL: https://github.com/Pylons/hupper
- Owner: Pylons
- License: mit
- Created: 2016-10-18T06:32:45.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T17:04:51.000Z (over 1 year ago)
- Last Synced: 2025-05-10T10:37:54.773Z (about 1 year ago)
- Topics: daemon, file-monitoring, inotify, python, reload, watchdog
- Language: Python
- Homepage: https://docs.pylonsproject.org/projects/hupper/en/latest/
- Size: 339 KB
- Stars: 220
- Watchers: 9
- Forks: 26
- Open Issues: 5
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-pyramid - hupper - A process monitor/reloader for developers (Settings)
README
======
hupper
======
.. image:: https://img.shields.io/pypi/v/hupper.svg
:target: https://pypi.python.org/pypi/hupper
.. image:: https://github.com/Pylons/hupper/actions/workflows/ci-tests.yml/badge.svg?branch=main
:target: https://github.com/Pylons/hupper/actions/workflows/ci-tests.yml?query=branch%3Amain
.. image:: https://readthedocs.org/projects/hupper/badge/?version=latest
:target: https://readthedocs.org/projects/hupper/?badge=latest
:alt: Documentation Status
``hupper`` is an integrated process monitor that will track changes to
any imported Python files in ``sys.modules`` as well as custom paths. When
files are changed the process is restarted.
Command-line Usage
==================
Hupper can load any Python code similar to ``python -m `` by using the
``hupper -m `` program.
.. code-block:: console
$ hupper -m myapp
Starting monitor for PID 23982.
API Usage
=========
Start by defining an entry point for your process. This must be an importable
path in string format. For example, ``myapp.scripts.serve.main``.
.. code-block:: python
# myapp/scripts/serve.py
import sys
import hupper
import waitress
def wsgi_app(environ, start_response):
start_response('200 OK', [('Content-Type', 'text/plain')])
yield b'hello'
def main(args=sys.argv[1:]):
if '--reload' in args:
# start_reloader will only return in a monitored subprocess
reloader = hupper.start_reloader('myapp.scripts.serve.main')
# monitor an extra file
reloader.watch_files(['foo.ini'])
waitress.serve(wsgi_app)
Acknowledgments
===============
``hupper`` is inspired by initial work done by Carl J Meyer and David Glick
during a Pycon sprint and is built to be a more robust and generic version of
Ian Bicking's excellent PasteScript ``paste serve --reload`` and Pyramid's
``pserve --reload``.