~ubuntu-branches/ubuntu/quantal/zeitgeist/quantal

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Siegfried-Angel Gevatter Pujals
  • Date: 2011-01-22 14:15:38 UTC
  • mfrom: (1.1.7 upstream) (6.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110122141538-8poh0211pn8uv1xc
Tags: 0.7-1
* New upstream release. Some of the changes are:
   - Various performance improvements (speed, reduced I/O, etc).
   - Enhancements to the extensions system (eg. feature to ask which
     extensions are active).
   - Various bug fixes (eg. fixed find_event_for_template Python API method).
   - Added new mimetype mappings.
* Updated debian/copyright and debian/zeitgeist-core.install.

Show diffs side-by-side

added added

removed removed

Lines of Context:
4
4
Zeitgeist is a service that logs the users activity. The log can be queried
5
5
and managed in various ways over a DBus API.
6
6
 
7
 
Note that this package only contains the daemon, which you can use
8
 
together with several different user interfaces. If you don't know
9
 
which to use, try out https://launchpad.net/gnome-zeitgeist/.
10
 
 
11
 
For more information, see:
12
 
 - https://launchpad.net/zeitgeist
13
 
 - http://zeitgeist-project.com/
14
 
 
15
 
----------------------------------------------------------------------
16
 
 
17
 
Dependencies:
 
7
This package contains the Zeitgeist Daemon, which is for all intents an
 
8
purposes an idle service. To take advantage of the Zeitgeist Daemon you
 
9
something that insert log statements into it (also known as data providers or
 
10
data sources) and you need some applications (or application plugins) to
 
11
query and display the logged data.
 
12
 
 
13
Zeitgeist Data Providers
 
14
------------------------
 
15
 
 
16
There is a host of data providers developed for Zeitgeist. There is a more
 
17
or less canonical data provider known as the Zeitgeist Data Hub, but note
 
18
that it is not more canonical that you can go without it if that is the better
 
19
option for you. The Zeitgeist Data Hub is hosted on Launchpad:
 
20
 
 
21
  https://launchpad.net/zeitgeist-datahub
 
22
 
 
23
There is also a suite of extra data providers which is available for
 
24
your cherry picking pleasure:
 
25
 
 
26
  https://launchpad.net/zeitgeist-dataproviders
 
27
 
 
28
Zeitgeist Client Libraries
 
29
--------------------------
 
30
 
 
31
For Python development this package also contains a complete async client
 
32
for working with the Zeitgeist DBus API. The API documentation can be build
 
33
if you have Sphinx installed, otherwise you can browse it online at:
 
34
 
 
35
 http://zeitgeist-project.com/documentation/
 
36
 
 
37
A GObject/C library for working with the Zeitgeist DBus API is available at:
 
38
 
 
39
  https://launchpad.net/libzeitgeist
 
40
 
 
41
A CLI/C# library is available from:
 
42
 
 
43
  https://launchpad.net/zeitgeist-sharp
 
44
 
 
45
You can also find the documentation for the raw DBus API on:
 
46
 
 
47
  http://zeitgeist-project.com/documentation/
 
48
 
 
49
Zeitgeist GUIs and Plugins
 
50
--------------------------
 
51
 
 
52
The Gnome Activity Journal (also known as just GAJ) is hosted on:
 
53
 
 
54
  https://launchpad.net/gnome-activity-journal
 
55
 
 
56
Or a light Zeitgeist powered file browser known as Sezen:
 
57
 
 
58
  https://launchpad.net/sezen
 
59
 
 
60
The Unity Shell (https://launchpad.net/unity) uses Zeitgeist in an indirect
 
61
way by querying its two data daemons; unity-place-files and
 
62
unity-place-applications:
 
63
 
 
64
  https://launchpad.net/unity-place-files
 
65
  https://launchpad.net/unity-place-applications
 
66
 
 
67
 
 
68
Zeitgeist Extensions
 
69
--------------------
 
70
 
 
71
You can write extensions for the core Zeitgeist daemon. These are written in
 
72
Python an run directly inside the Zeitgeist Daemon process with raw access to
 
73
the underlying database. This is not normally something you need to do, but
 
74
if you have very special needs that are unlikely to get accepted in the core
 
75
Zeitgeist Daemon you can almost certainly get away with with doing it as an
 
76
extension.
 
77
 
 
78
There is a collection of Zeitgeist Extensions developed on:
 
79
 
 
80
  https://launchpad.net/zeitgeist-extensions
 
81
 
 
82
Notably this suite of extensions contain the Zeitgeist Full Text Search (FTS)
 
83
extension which is needed by some GUI tools in order to give full text search
 
84
capabilities to the daemon.
 
85
 
 
86
Extensions can be deployed simply by dropping a Python module in either
 
87
$PREFIX/share/zeitgeist/_zeitgeist/engine/extensions or for developers and the
 
88
adventurous users they can be deployed in the home directory under
 
89
~/.local/share/zeitgeist/extensions/. Note that user extensions take precendence
 
90
over the system installed ones.
 
91
 
 
92
 
 
93
Official Website
 
94
----------------
 
95
 
 
96
  http://zeitgeist-project.com/
 
97
 
 
98
 
 
99
Dependencies
 
100
------------
 
101
 
 
102
For building from a release tarball you need:
18
103
 
19
104
 - python 2.5 or higher
20
105
 - python-gobject (2.16.0 or higher)
21
106
 - python-dbus
22
107
 - python-xdg
 
108
 
 
109
Additionally, if building from a source code checkout you need:
 
110
 
 
111
 - rapper (RDF conversion tool)
 
112
 - rdflib (Python module for working with RDF graphs)
 
113