From 74edacee9c186cfeab07fad3af190fdecfcc3cce Mon Sep 17 00:00:00 2001 From: Marek Marecki Date: Wed, 18 Dec 2013 20:56:36 +0100 Subject: [PATCH] Updated docs --- README.md | 22 +++++++++++++++++++++- diaspy/__init__.py | 2 +- diaspy/people.py | 3 +++ docs/source/client.rst | 7 ------- docs/source/conf.py | 10 +++++----- docs/source/modules.rst | 5 +++-- docs/source/notifications.rst | 7 +++++++ docs/source/settings.rst | 7 +++++++ 8 files changed, 47 insertions(+), 16 deletions(-) delete mode 100644 docs/source/client.rst create mode 100644 docs/source/notifications.rst create mode 100644 docs/source/settings.rst diff --git a/README.md b/README.md index e77a0bf..9c3613e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -#### Unofficial Python interface for Diaspora\* social network +## Unofficial Python interface for Diaspora\* social network `diaspy` is a set of modules which form an Python interface to the API of Disapora\* social network. @@ -15,6 +15,25 @@ 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/) + + ---- #### Quick intro @@ -31,6 +50,7 @@ You only need two objects to do this: `Stream()` and `Connection()`. >>> stream = diaspy.streams.Stream(c) >>> stream.post('Your first post') +---- #### 2. Reference implementation diff --git a/diaspy/__init__.py b/diaspy/__init__.py index 36317c3..65860e4 100644 --- a/diaspy/__init__.py +++ b/diaspy/__init__.py @@ -10,4 +10,4 @@ import diaspy.notifications as notifications import diaspy.settings as settings -__version__ = '0.4.2' +__version__ = '0.4.3' diff --git a/diaspy/people.py b/diaspy/people.py index a347ecf..3748204 100644 --- a/diaspy/people.py +++ b/diaspy/people.py @@ -1,3 +1,6 @@ +#!/usr/bin/env python3 + +import json import re from diaspy.streams import Outer from diaspy.models import Aspect diff --git a/docs/source/client.rst b/docs/source/client.rst deleted file mode 100644 index 9739705..0000000 --- a/docs/source/client.rst +++ /dev/null @@ -1,7 +0,0 @@ -client Module -============= - -.. automodule:: diaspy.client - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py index f7db2b4..439b0e0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -44,16 +44,16 @@ master_doc = 'index' # General information about the project. project = 'diaspy' -copyright = '2013, Moritz Kiefer' +copyright = '2013, Moritz Kiefer, Marek Marecki and others' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.3.0' +version = '0.4.3' # The full version, including alpha/beta/rc tags. -release = '0.3.0' +release = '0.4.3' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -217,7 +217,7 @@ latex_documents = [ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'diaspy', 'diaspy Documentation', - ['Moritz Kiefer'], 1) + ['Moritz Kiefer and Marek Marecki'], 1) ] # If true, show URL addresses after external links. @@ -231,7 +231,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ ('index', 'diaspy', 'diaspy Documentation', - 'Moritz Kiefer', 'diaspy', 'One line description of project.', + 'Moritz Kiefer and Marek Marecki', 'diaspy', 'One line description of project.', 'Miscellaneous'), ] diff --git a/docs/source/modules.rst b/docs/source/modules.rst index b711080..a5d9aad 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -7,8 +7,9 @@ diaspy connection models streams - conversations + notifications people + settings search + conversations errors - client diff --git a/docs/source/notifications.rst b/docs/source/notifications.rst new file mode 100644 index 0000000..e9a26eb --- /dev/null +++ b/docs/source/notifications.rst @@ -0,0 +1,7 @@ +notifications Module +==================== + +.. automodule:: diaspy.notifications + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/settings.rst b/docs/source/settings.rst new file mode 100644 index 0000000..a30cd7f --- /dev/null +++ b/docs/source/settings.rst @@ -0,0 +1,7 @@ +settings Module +=============== + +.. automodule:: diaspy.settings + :members: + :undoc-members: + :show-inheritance: -- 2.25.1