Skip to content

Latest commit

 

History

67 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

py-mon

A modern, easy-to-use package to automatically restart a Python application when file changes are detected!

Quickstart (10s)

pip install -U py-mon
pymon app.py

Zero-config reloads for Python files by default. Requires Python 3.9+.

Why py-mon?

  • Works for Python files or any shell command (-x "npm run dev").
  • Simple patterns for watch/ignore; sane defaults.
  • Clean/quiet mode available when you don’t want prompts.

Core flags

  • -w / --watch <pattern>: what to watch (default *.py).
  • -i / --ignore <pattern>: what to ignore.
  • -x / --exec: run a shell command instead of python <file>.
  • -d / --debug: print changed paths.
  • -c / --clean: no logs, no stdin commands.
  • --delay <ms>: wait this long after the last change before restarting (default 250), so editor save bursts trigger one restart.

Command Input

When running pymon, you can use these commands:

  • Type rs to manually restart the process
  • Type stop to terminate pymon

If stdin is not available (e.g. running in CI or under a process manager), pymon keeps watching with command input disabled. When pymon stops or restarts your program, it terminates the whole process group, so shell commands started with -x don't leave stray child processes behind.

Optional Config File

Put a .pymonrc or pymon.json in your project root to keep team settings consistent:

{
  "watch": ["*.py", "config/*.yaml"],
  "ignore": ["*__pycache__*", "*.log"],
  "debug": false,
  "clean": false,
  "exec": false,
  "delay": 250
}

Command line arguments will always override config file settings.

__pycache__, .pyc/.pyo files and .git internals are always ignored, in addition to any ignore patterns you set.

Anyway that's basically it! Thanks for everything, I would appreciate it if you could leave a follow or star this repository ❣️ If you have any feature requests, read below!

Contributing

This package is open source so anyone with adequate Python experience can contribute to this project!

Report Issues

If you find any issues with the package or in the code, please create an issue and report it here!

Fix/Edit Content

If you want to contribute to this package, fork the repository, clone it, make your changes and then proceed to create a pull request here

Tests

Run the test suite locally with pytest:

pip install -e ".[dev]"
pytest

About

🔁 Automatically restart application when file changes are detected; made for development

Topics

Resources

Stars

81 stars

Watchers

3 watching

Forks

Used by

Contributors

Languages