auto-live-reload 1.0.2

A Python library for live reloading scripts on file changes.

🚀 auto-auto-live-reload

A lightweight Python utility that watches your project for source changes and automatically restarts the current process.

Perfect for speeding up local development of CLIs, scripts, and small services.

---

📚 Table of Contents

• Features
• Installation
• Quick Start
• Configuration
• Command-line Helper
• Development
• License

---

✨ Features

• 🔍 Watches files matching customizable glob patterns (defaults to *.py).
• 🚫 Optional exclusion patterns keep temporary or generated files out of the watch list.
• 🗂️ Recursive directory walking with the ability to opt out for flat projects.
• ⏱️ Configurable polling interval and initial delay to fit your workload.
• 🗒️ Verbose logging to understand which files triggered a restart.
• 🧵 Runs the watcher on a daemon thread so your application code can proceed normally.

📦 Installation

pip install auto-live-reload
# Version: 1.0.1

Or, for local development:

pip install -e .

⚡ Quick Start

Call start_auto_live_reload() as early as possible in your entry point (version 1.0.1):

from auto_live_reload import start_auto_live_reload

start_auto_live_reload()

def main():
    print("Running business logic…")
    # ...

if __name__ == "__main__":
    main()

Any changes to watched files will restart your script automatically.

⚙️ Configuration

You can customize the behavior using arguments:

start_auto_live_reload(
    patterns=["*.py", "*.jinja"],
    delay=1,
)

• patterns: List of file patterns to watch (default: ['*.py']).
• delay: Initial delay before watching starts (default: 2).

🖥️ Command-line Helper

A thin CLI wrapper is exposed through auto_live_reload.main(). You can wire it into your own console script entry point or invoke it manually during development:

python -c "import auto_live_reload; auto_live_reload.main()" --interval 2 --patterns "*.py" "*.md"

The available flags mirror the keyword arguments listed above:

• --patterns, --exclude, --interval, --delay, --no-recursive, and --verbose

The CLI keeps the current process alive, making it ideal for quickly testing live reload behaviour without modifying your application code.

🛠️ Development

1. Clone the repository and install dependencies in editable mode:

   pip install -e .
   

2. Run your application or sample script with start_auto_live_reload() enabled.
3. Make code changes and confirm that the process restarts automatically.

---

📄 License

This project is licensed under the MIT License.

---

🙌 Issues and pull requests are welcome!