Merge branch 'feature/provider_display_name' of https://github.com/svbergerem/diaspy...
[diaspy.git] / Changelog.markdown
index 304079c9b86afb3103a7cc6200d9c15a2221d557..2470848c7aa6c5f2812da26e4ef360bc78797b8d 100644 (file)
@@ -1,4 +1,4 @@
-## Changelog for `diaspy`, unofficla Diaspora\* API for Python
+## Changelog for `diaspy`, unofficial DIASPORA\* interface for Python
 
 This changelog file follows few rules:
 
@@ -18,6 +18,99 @@ up-to-date than manual and if conflicts appear they should follow the order:
 
 *docstrings* -> *docs/* -> *manual/*
 
+----
+
+#### Known issues
+
+* __bug__:  `diaspy` has problems/can't connect to pods using SNI (this is an issue with requests/urllib3/python),
+
+
+----
+
+#### Version `0.4.1` (2013-09-):
+
+Login and authentication procedure backend received major changes in this version.
+There are no longer `username` and `password` variables in `Connection` object.
+Instead, credentials are stored (together with the token) in single variable `_login_data`.
+This is preserved until you call `login()` at which point credentials are erased and
+only token is left -- it can be obtained by calling `repr(Connection)`.
+
+Also, this release is compatible with DIASPORA\* 0.2.0.0 but should still support
+pods running on older versions.
+
+And the test suite was updated. Yay!
+
+**`0.4.1-rc.2` (2013-09-06):**
+
+* __new__:  `diaspy.search.Search.tags()` method for getting tag suggestions,
+* __new__:  `diaspy.settings.Profile.getName()` method,
+* __new__:  `diaspy.settings.Profile.getBio()` method,
+* __new__:  `diaspy.settings.Profile.getLocation()` method,
+* __new__:  `diaspy.settings.Profile.getLocation()` method,
+* __new__:  `diaspy.settings.Profile.getGender()` method,
+* __new__:  `diaspy.settings.Profile.getBirthDate()` method,
+* __new__:  `diaspy.settings.Profile.isSearchable()` method,
+* __new__:  `diaspy.settings.Profile.isNSFW()` method,
+
+* __upd__:  `remeber_me` parameter in `diaspy.connection.Connection.login()`,
+* __upd__:  you must supply `username` and `password` parameters on init of `diaspy.connection.Connection`,
+* __upd__:  you must update your testconf.py (new fields are required for settings tests),
+* __upd__:  `diaspy.settings.Settings` renamed to `diaspy.settings.Account`,
+
+* __rem__:  `username` and `password` parameters removed from `diaspy.connection.Connection.login()`
+            must be supplied on init,
+
+
+**`0.4.1-rc.1` (2013-09-02):**
+
+* __new__:  `__getitem__()` in `diaspy.models.Post`,
+* __new__:  `__dict__()` in `diaspy.models.Post`,
+* __new__:  `guid` argument in `diaspy.models.Post.__init__()`,
+* __new__:  `json()` method in `diaspy.streams.Generic` adds the possibility to export streams to JSON,
+* __new__:  `full()` method in `diaspy.streams.Generic` will try to fetch full stream (containing all posts),
+* __new__:  `setEmail()` method in `diaspy.settings.Settings`,
+* __new__:  `setLanguage()` method in `diaspy.settings.Settings`,
+* __new__:  `downloadPhotos()` method in `diaspy.settings.Settings`,
+* __new__:  `backtime` argument in `more()` method in `diaspy.streams.Generic`,
+* __new__:  `DiaspyError` will be raised when connection is created with empty password and/or username,
+* __new__:  `getSessionToken()` method in `diaspy.connection.Connection` returns string from `_diaspora_session` cookie,
+* __new__:  `direct` parameter in `diaspy.connection.Connection().get()` allowing to disable pod expansion,
+
+* __upd__:  if `Post()` is created with fetched comments, data will also be fetched as a dependency,
+* __upd__:  `id` argument type is now `int` (`diaspy.models.Post.__init__()`),
+* __upd__:  `Search().lookup_user()` renamed to `Search().lookupUser()`,
+* __upd__:  `diaspy.messages` renamed to `diaspy.conversations` (but will be accessible under both names for this and next release),
+* __upd__:  `LoginError` moved to `diaspy.errors`,
+* __upd__:  `TokenError` moved to `diaspy.errors`,
+* __upd__:  `diaspy.connection.Connection.podswitch()` gained two new positional arguments: `username` and `password`,
+* __upd__:  `aspect_id` renamed to `id` in `diaspy.streams.Aspects().remove()`,
+
+* __fix__:  fixed some bugs in regular expressions used by `diaspy` internals
+            (html tag removal, so you get nicer notifications),
+* __fix__:  fixed authentication issues,
+
+
+----
+
+#### Version `0.4.0` (2013-08-20):
+
+This release is **not backwards compatible with `0.3.x` line**! You'll have to check your code for corrections.
+Also, this release if first to officially released fork version.
+
+* __dep__:  `diaspy.client` is officially deprecated (will be removed in `0.4.1`),
+
+* __upd__:  `diaspy.conversations` renamed to `diaspy.messages`,
+* __udp__:  `diaspy.conversations.Conversation` moved to `diaspy.models`,
+
+* __new__:  `diaspy.messages.Mailbox()` object representing diaspora\* mailbox,
+
+----
+
+Version `0.3.2` (2013-08-20):
+
+* __upd__:  `diaspy.connection.getUserData()` raises `DiaspyError` when it cannot find user data,
+
+* __rem__:  `diaspy.client.Client` must be explicitly imported,
 
 ----