====================================================================
          DJANGO HOOKS - REUSABLE HOOK SYSTEM
           Production-Ready | Type-Safe | Flexible
====================================================================

QUICK START (5 Minutes)
-----------------------

1. Copy to your project:
   $ cp -r django_hooks/ /path/to/your/project/

2. Define your context:
   @dataclass(frozen=True)
   class MyHookContext(HookContext):
       entity_id: str
       user_id: int

3. Create hooks:
   def validate(context): ...
   register_hook('validate', HookType.PRE, validate, priority=10)

4. Execute in service:
   manager.execute_pre_hooks(context)
   # ... do operation ...
   manager.execute_post_hooks(context)

WHAT'S INCLUDED
---------------

📚 Documentation (2 files):
   • README.md - Complete API reference, examples, best practices
   • IMPLEMENTATION.md - Step-by-step integration guide (20KB)

💻 Core Package (3 files):
   • django_hooks/__init__.py - Public API
   • django_hooks/core.py - Hook system implementation
   • django_hooks/exceptions.py - Exception hierarchy

📝 Examples (1 file):
   • examples/cronjob_hooks.py - 7 production-ready hooks

🧪 Tests (1 file):
   • tests/test_hooks_example.py - 22 test cases

⚙️ Setup:
   • pyproject.toml - Package configuration
   • setup-git.sh - Git initialization script
   • LICENSE - MIT license

FEATURES
--------

✅ Two-phase hooks (PRE can reject, POST captures errors)
✅ Priority-based execution (lower = higher priority)
✅ Type-safe with full type hints
✅ Structured error codes for frontend
✅ Backward compatible (opt-in)
✅ Zero dependencies (pure Python)
✅ Production-ready

DOCUMENTATION
-------------

Start with:    README.md (API reference)
Implement:     IMPLEMENTATION.md (integration guide)
Example:       examples/cronjob_hooks.py
Tests:         tests/test_hooks_example.py

GIT SETUP
---------

$ cd ai-output/hooks
$ ./setup-git.sh
  (Interactive setup script)

Or manually:
$ git init
$ git add .
$ git commit -m "Initial commit"
$ git remote add origin https://github.com/YOUR_USERNAME/django-hooks.git
$ git push -u origin main

NEXT STEPS
----------

For django-cronjob-utils:
1. Copy django_hooks/ to src/cronjob_utils/
2. Read IMPLEMENTATION.md
3. Define CronjobHookContext
4. Integrate with CronjobService
5. Create example hooks
6. Write tests

Estimated time: 7-12 hours for full implementation

SUPPORT
-------

• README.md - API reference
• IMPLEMENTATION.md - Integration guide
• examples/ - Working examples
• tests/ - Test examples

====================================================================
Version: 1.0.0 | License: MIT | Python: 3.9+ | Django: 3.2+
====================================================================