Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add watchfiles #2601

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add watchfiles #2601

wants to merge 1 commit into from

Conversation

K-dash
Copy link

@K-dash K-dash commented Jul 28, 2024

What is this Python project?

watchfiles is a simple, modern, and high-performance file watching and code reload library for Python. Its key features include:

  • Efficient file system notifications using the Rust-based Notify library
  • Both synchronous and asynchronous APIs (watch, awatch, run_process, arun_process)
  • Ability to monitor multiple files and directories simultaneously
  • Customizable filters for detecting specific changes
  • Command-line interface (CLI) for running and reloading Python code
  • Used by uvicorn for its hot reload feature, enhancing development workflows

What's the difference between this Python project and similar ones?

watchfiles stands out from other file monitoring libraries(ex: watchdog) in several ways:

  • Performance
    • Rust-based implementation offers superior speed and efficiency
  • Cross-platform compatibility
    • Optimized for Linux, macOS, and Windows
  • API simplicity
    • Intuitive and easy-to-use interface
  • Asynchronous support
    • Seamless integration with asyncio
  • Customizability
    • Flexible filtering options for monitoring specific file types or changes
  • Active development
    • Ongoing improvements and bug fixes
  • Comprehensive documentation
  • Integration with popular tools
    • Powers uvicorn's hot reload functionality
  • Modern design
    • Built to address contemporary Python development needs
  • Efficient resource usage
    • Implements debouncing to group changes and reduce unnecessary reloads

--

Anyone who agrees with this pull request could submit an Approve review to it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants