1 ## Unofficial Python interface for Diaspora\* social network
3 `diaspy` is a set of modules which form an Python interface to the API of
4 Disapora\* social network.
6 Test suite will cause problems when run with 2.x so testing should be done
7 using python3 interpreter.
9 Object oriented design of `diaspy` makes it easily reusable by other
10 developers who want to use only part of the interface and create derivative
13 Developrs who don't like the design of `diaspy` and want to create something better
14 can use only `diaspy.connection.Connection()` object as it is capable of
15 doing everything. Other modules are just layers that provide easier access to
16 parts of the Diaspora\* API.
22 List of software `diaspy` requires to run.
23 Versions used by maintainer are the ones available in stock Arch x86\_64 repositories.
28 [Website](https://www.python.org/)
34 [Website](http://docs.python-requests.org/en/latest/)
41 #### 1. Posting text to your stream
43 You only need two objects to do this: `Stream()` and `Connection()`.
46 >>> c = diaspy.connection.Connection(pod='https://pod.example.com',
50 >>> stream = diaspy.streams.Stream(c)
51 >>> stream.post('Your first post')
55 #### 2. Reference implementation
57 There is no official reference implementation of D\* client using `diaspy`.
58 The `diaspy.client` module is no longer maintained and will be removed in the future.
60 However, there is a small script written that uses `diaspy` as its backend.
61 Look for `diacli` in marekjm's repositories on GitHub.
65 To get more information about how the code works read
66 documentation (`./doc/` directory) and manual (`./manual/` directory).