P4Review2

P4Review2 is a fresh take on the original review daemon with enhancement and new features.

= FEATURES HIGHLIGHT =


 * Authenticates against SMTP and Perforce servers with TLS/SSL support.


 * Unicode support - even for non-ACSII characters in non-unicode enabled server if you use a single encoding.


 * Configurable email templates which an be hooked with P4Web and Swarm.


 * Option to send summary email per user per invocation instead of one for each change.


 * Put limits on the maximum message size and number of emails that get sent.


 * Guards to prevent running multiple instances of the script by mistake.


 * Built-in logging and extensive command-line options to facilitate debug and testing.


 * Use P4Python when available for efficiency and fallback to the Perforce command line client gracefully.


 * Option for users to opt-in (--opt-in-path) reviews from P4Review2 for smooth migration from other review notification systems.

= Usage =


 * 1) Create an sample configuration: python p4review2.py --sample-config > p4review2.conf
 * 2) The file is in INI-like format. Edit the file to suit your needs. In particular, check settings for the following (check "python p4review2.py -h" for a list of all the current options):
 * 3) p4port
 * 4) p4user
 * 5) p4charset
 * 6) review_counter
 * 7) job_counter
 * 8) change_url
 * 9) job_url
 * 10) user_url
 * 11) Test the configuration with: python p4review2.py -c p4review2.conf -P
 * 12) When ready, create a crontab (Linux/UNIX)/scheduled task (Windows) to run the above command without the -P option.
 * 13) Configuration can be overwritten on the command line via options. See python p4review2.py -h for the complete list.

= Feedback/Contact =

I can be contacted via one of the following:


 * Twitter: | P4Lester
 * | Perforce Forum
 * Email: lcheung [at] perforce.com