https://github.com/marekjm/diaspy

Unofficial Python interface to the DIASPORA* social network
https://github.com/marekjm/diaspy

diaspora python social-network

Last synced: 7 days ago
JSON representation

Unofficial Python interface to the DIASPORA* social network

• Host: GitHub
• URL: https://github.com/marekjm/diaspy
• Owner: marekjm
• License: mit
• Created: 2013-08-08T16:33:08.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2023-05-22T20:45:28.000Z (over 1 year ago)
• Last Synced: 2024-10-19T10:40:32.369Z (19 days ago)
• Topics: diaspora, python, social-network
• Language: Python
• Homepage:
• Size: 457 KB
• Stars: 58
• Watchers: 12
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.markdown
  • License: LICENSE

Awesome Lists containing this project

README

        
## Unofficial Python interface for Diaspora\* social network

[![Diaspy on PyPI](https://badge.fury.io/py/diaspy-api.png)](https://pypi.python.org/pypi/diaspy-api)

`diaspy` is a set of modules which form an Python interface to the API of

Diaspora\* social network. 

Test suite will cause problems when run with 2.x so testing should be done 

using python3 interpreter.

Object oriented design of `diaspy` makes it easily reusable by other 

developers who want to use only part of the interface and create derivative

works from it.

Developers who don't like the design of `diaspy` and want to create something better

can use only `diaspy.connection.Connection()` object as it is capable of

doing everything. Other modules are just layers that provide easier access to

parts of the Diaspora\* API.

----

### Dependencies

List of software `diaspy` requires to run.

Versions used by maintainer are the ones available in stock Arch x86\_64 repositories.

**`python`**

Version: 3.3.3

[Website](https://www.python.org/)

**`python-requests`**

Version: 2.1.0

[Website](http://docs.python-requests.org/en/latest/)

**`python-dateutil`**

Version: >= 2.2

[Website](https://github.com/dateutil/dateutil)

*Optional:* **`python-beautifulsoup4`**

[Website](https://www.crummy.com/software/BeautifulSoup/)

----

#### Quick intro

#### 1. Posting text to your stream

You only need two objects to do this: `Stream()` and `Connection()`. 

    >>> import diaspy

    >>> c = diaspy.connection.Connection(pod='https://pod.example.com',

    ...                                  username='foo',

    ...                                  password='bar')

    >>> c.login()

    >>> stream = diaspy.streams.Stream(c)

    >>> stream.post('Your first post')

----

#### 2. Reference implementation

There is no official reference implementation of D\* client using `diaspy`.

The `diaspy.client` module is no longer maintained and will be removed in the future.

However, there is a small script written that uses `diaspy` as its backend.

Look for `diacli` in marekjm's repositories on GitHub.

----

To get more information about how the code works read 

documentation (`./doc/` directory) and manual (`./manual/` directory).