Thorsten Weimann avatar Thorsten Weimann committed d9026c1

Added new example.

Comments (0)

Files changed (1)

     # Extending with own info function
     >>> import specbar
     >>> @specbar.info_collector(42)
-    >>> def get_something(num):
-            return dict(square=num**2)
+    ... def get_some_info(num):
+    ...     return dict(square=num**2)
+    ...
+    >>> specbar.loop(format_str='Square info: {square}')
+    Square info: 1764
+    Shutting down specbar...
     >>>
-    >>> specbar.loop(format_str='Square info: {square}')
 
 That's it now your own function get's called every 5 (default) seconds and
-the format string is displayed in the statusbar.
+the format string is displayed in the statusbar. The loop (when testing) can
+easily killed by pressing CTRL+C.
 
 Using builtin functions::
 
 
 Now every 15 seconds your Gmail account is checked for new mail and the
 result is displayed.
+
+Every info function must return a dict. All dicts where merged in a
+defaultdict to have no exception on missing keys. See the source of
+specbar.py for the returned keys of the builtin functions.
+
+In the source distribution an example.py file is included which shows
+the usage of specbar.py.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.