~paulliu/friends/add-twitter-contacts

4 by Barry Warsaw
Post-merge cleanup.
1
==================
1.2.1 by Robert Bruce Park
Drop support for messaging / indicators.
2
Installing Friends
3
==================
4
4 by Barry Warsaw
Post-merge cleanup.
5
Requirements
6
============
7
8
Package requirements.
1.2.1 by Robert Bruce Park
Drop support for messaging / indicators.
9
10
    * gir1.2-dee-1.0
11
    * gir1.2-gdkpixbuf-2.0
12
    * gir1.2-glib-2.0
13
    * gir1.2-networkmanager-1.0
14
    * gir1.2-signon-1.0
15
    * gir1.2-soup-2.4
16
    * gir1.2-soup-gnome-2.4
4 by Barry Warsaw
Post-merge cleanup.
17
    * python3 (>= 3.2, although 3.3 will soon be required)
18
    * python3-distutils-extra
19
    * python3-dbus
25 by Robert Bruce Park
Merged lp:~cjcurran/friends/facebook-contacts.
20
    * gir1.2-ebook-1.2
21
    * gir1.2-edataserver-1.2
3.3.4 by Conor Curran
more typo fixes
22
    * python3-mock
4 by Barry Warsaw
Post-merge cleanup.
23
24
25
Installation
26
============
27
6 by Barry Warsaw
* Add a wrapper script for easier in-source execution. (LP: #1067005)
28
If you want to run the ``friends-service`` executable locally for testing
29
purposes, you can do it in one of two ways.  To run the service as would
30
typically happen once the system package was installed, create a Python
31
virtual environment, and run the service from there.  Fortunately, the
32
``Makefile`` makes this easy::
33
34
    $ make venv
35
    $ /tmp/friends/bin/friends-service
36
37
When you make changes in the source, just run ``make venv`` again to refresh
38
the virtual environment.
39
40
It may be easier during development to run the service directly from the
41
source directory.  This should generally be good enough for development
42
purposes, but again, doesn't exactly mimic how the service will be installed
43
by the system package::
44
45
    $ ./friends-service.sh
46
47
This is a little bit more fragile, since you must be in the top-level source
48
directory for this to work.
49
50
Once the service is running, it will access Ubuntu Online Accounts for all
51
your microblogging-enabled accounts, and then retrieve all the public messages
52
present on those accounts.  Those messages can then be accessed over DBus,
53
using a Dee.SharedModel.
4 by Barry Warsaw
Post-merge cleanup.
54
55
56
Testing
57
=======
58
59
You can run most of the test suite with the command ``make check``.  This will
60
not include any dbus-enabled tests, which you can run with the command ``make
61
check_all``.
62
63
You can do some microblogging from the command line with::
64
65
    $ ./tools/debug_live.py twitter send 'Hello, World!'