| 1 |
============================ |
| 2 |
GoogleMail Sentinel README |
| 3 |
============================ |
| 4 |
|
| 5 |
About |
| 6 |
===== |
| 7 |
|
| 8 |
GoogleMail Sentinel is a mail notifier for Google Mail (Gmail) that |
| 9 |
creates an icon in your Taskbar to notify you about incoming email to |
| 10 |
your inbox. Uses a plugin system to implement other notification |
| 11 |
methods. |
| 12 |
|
| 13 |
Features |
| 14 |
======== |
| 15 |
|
| 16 |
* Written in python |
| 17 |
* Uses gtk+ (status icon) |
| 18 |
* Threaded plugin system |
| 19 |
* Multilingual (using gettext) |
| 20 |
|
| 21 |
Limitations |
| 22 |
=========== |
| 23 |
|
| 24 |
1. It hasn't been tested on Mac or Windows |
| 25 |
2. It doesn't have a configuration GUI (this is done by design) |
| 26 |
|
| 27 |
Requirements |
| 28 |
============ |
| 29 |
|
| 30 |
Python (version 2.4 or higher - tested with 2.4.4) |
| 31 |
PyGTK (version 2.10 or higher - tested with 2.12.0) |
| 32 |
Gtk+ (version 2.10 or higher - tested with 2.12.5) |
| 33 |
|
| 34 |
NotifyPlugin |
| 35 |
------------ |
| 36 |
libnotify (tested with 0.4.4) |
| 37 |
pynotify (version 0.1.1 - tested with 0.1.1) |
| 38 |
|
| 39 |
Current Status |
| 40 |
============== |
| 41 |
|
| 42 |
Gmail-sentinel is under development, is not intended for general usage |
| 43 |
yet. |
| 44 |
|
| 45 |
History |
| 46 |
======= |
| 47 |
|
| 48 |
It started as a personal itch. There are many other similar apps, but |
| 49 |
I didn't like any of those. http://gmail-notify.sourceforge.net/ was |
| 50 |
the closest to good I could find but it has some drawbacks. |
| 51 |
|
| 52 |
* It didn't work on x86_64 (amd64) by default. |
| 53 |
* It uses a binary object that creates the status icon (and because |
| 54 |
it was compiled under x86 it didn't worked on amd64) |
| 55 |
* Notifications didn't use libnotify (more on this latter) |
| 56 |
* Translations were made using xml |
| 57 |
|
| 58 |
My main goal was, beside learning, to create an app that: |
| 59 |
|
| 60 |
* Uses gtk.StatusIcon? for the icon in the task bar |
| 61 |
* Uses libnotify to display the notifications |
| 62 |
* Use gettext for translations |
| 63 |
* Reduce the code size (and hopefully the memory footprint) |
| 64 |
|
| 65 |
gmail-sentinel is what I came up with. It does everything that I |
| 66 |
want. gmail-sentinel is originally a fork of gmail-notify but at this |
| 67 |
time there isn't much code left from gmail-notify. |
| 68 |
|
| 69 |
There isn't an official 0.2 version, only a release candidate. What |
| 70 |
happen was that the development mode changed before a 0.2 version was |
| 71 |
released. The old model requiered that for each new "big" feature a |
| 72 |
new minor version should be released. The new model is more |
| 73 |
traditional, so a minor version increment requiere a set of new |
| 74 |
features. This project is expected to never reach beyond 1.x |
| 75 |
version. As version 1.0 will be the first production ready it will be |
| 76 |
a huge milestone to achive. |
| 77 |
|
| 78 |
|
| 79 |
Disclaimer |
| 80 |
========== |
| 81 |
|
| 82 |
GoogleMail?, Gmail and Google are trademarks of Google, Inc. This is |
| 83 |
project has no relationship with Google, Inc beside using it's code |
| 84 |
hosting service. |
