Changelog.markdown

   1 ## Changelog for `diaspy`, unofficial DIASPORA\* interface for Python
   2
   3 This changelog file follows few rules:
   4
   5 *   __rem__:    indicates removed features,
   6 *   __new__:    indicates new features,
   7 *   __upd__:    indicates updated features,
   8 *   __dep__:    indicates deprecated features,
   9
  10 Deprecation means that in the next version feature will be removed.
  11
  12 Also, after every version there should be a brief note describing possible
  13 problems with migrating to it from older versions and usage of new features.
  14
  15 Users can always read the manual and dcumentation to make themselves more knowledgeable and
  16 are encouraged to do so. They only need to remember that documentation is usually more
  17 up-to-date than manual and if conflicts appear they should follow the order:
  18
  19 *docstrings* -> *docs/* -> *manual/*
  20
  21 ----
  22
  23 #### Known issues
  24
  25 * __bug__:  `diaspy` has problems/can't connect to pods using SNI (this is an issue with requests/urllib3/python),
  26
  27
  28 ----
  29
  30 #### Version `0.4.1` (2013-09-):
  31
  32 Login and authentication procedure backend received major changes in this version.
  33 There are no longer `username` and `password` variables in `Connection` object.
  34 Instead, credentials are stored (together with the token) in single variable `_login_data`.
  35 This is preserved until you call `login()` at which point credentials are erased and
  36 only token is left -- it can be obtained by calling `repr(Connection)`.
  37
  38 Also, this release is compatible with DIASPORA\* 0.2.0.0 but should still support
  39 pods running on older versions.
  40
  41 And the test suite was updated. Yay!
  42
  43
  44 * __new__:  `diaspy.errors.SettingsError`,
  45
  46
  47 * __upd__:  `diaspy.settings.Account.setEmail()` can now raise `SettingsError` when request fails,
  48 * __upd__:  `diaspy.settings.Account.getEmail()` will now return empty string instead of raising an exception if cannot fetch mail,
  49 * __upd__:  improved language fetching in `diaspy.settings.Account.getLanguages()`,
  50
  51
  52 **`0.4.1-rc.3` (2013-09-08):**
  53
  54 * __new__:  `diaspy.settings.Profile.load()` method for loading profile information,
  55 * __new__:  `diaspy.settings.Profile.update()` method for updating profile information,
  56 * __new__:  `diaspy.settings.Profile.setName()` method,
  57 * __new__:  `diaspy.settings.Profile.setBio()` method,
  58 * __new__:  `diaspy.settings.Profile.setLocation()` method,
  59 * __new__:  `diaspy.settings.Profile.setTags()` method,
  60 * __new__:  `diaspy.settings.Profile.setGender()` method,
  61 * __new__:  `diaspy.settings.Profile.setBirthDate()` method,
  62 * __new__:  `diaspy.settings.Profile.setSearchable()` method,
  63 * __new__:  `diaspy.settings.Profile.setNSFW()` method,
  64
  65
  66 **`0.4.1-rc.2` (2013-09-06):**
  67
  68 * __new__:  `diaspy.search.Search.tags()` method for getting tag suggestions,
  69 * __new__:  `diaspy.settings.Profile.getName()` method,
  70 * __new__:  `diaspy.settings.Profile.getBio()` method,
  71 * __new__:  `diaspy.settings.Profile.getLocation()` method,
  72 * __new__:  `diaspy.settings.Profile.getTags()` method,
  73 * __new__:  `diaspy.settings.Profile.getGender()` method,
  74 * __new__:  `diaspy.settings.Profile.getBirthDate()` method,
  75 * __new__:  `diaspy.settings.Profile.isSearchable()` method,
  76 * __new__:  `diaspy.settings.Profile.isNSFW()` method,
  77 * __new__:  `provider_display_name` parameter in `diaspy.streams.Stream.post()` (thanks @svbergerem),
  78
  79
  80 * __upd__:  `remeber_me` parameter in `diaspy.connection.Connection.login()`,
  81 * __upd__:  you must supply `username` and `password` parameters on init of `diaspy.connection.Connection`,
  82 * __upd__:  you must update your testconf.py (new fields are required for settings tests),
  83 * __upd__:  `diaspy.settings.Settings` renamed to `diaspy.settings.Account`,
  84
  85
  86 * __rem__:  `username` and `password` parameters removed from `diaspy.connection.Connection.login()`
  87             must be supplied on init,
  88
  89
  90 **`0.4.1-rc.1` (2013-09-02):**
  91
  92 * __new__:  `__getitem__()` in `diaspy.models.Post`,
  93 * __new__:  `__dict__()` in `diaspy.models.Post`,
  94 * __new__:  `guid` argument in `diaspy.models.Post.__init__()`,
  95 * __new__:  `json()` method in `diaspy.streams.Generic` adds the possibility to export streams to JSON,
  96 * __new__:  `full()` method in `diaspy.streams.Generic` will try to fetch full stream (containing all posts),
  97 * __new__:  `setEmail()` method in `diaspy.settings.Settings`,
  98 * __new__:  `setLanguage()` method in `diaspy.settings.Settings`,
  99 * __new__:  `downloadPhotos()` method in `diaspy.settings.Settings`,
 100 * __new__:  `backtime` argument in `more()` method in `diaspy.streams.Generic`,
 101 * __new__:  `DiaspyError` will be raised when connection is created with empty password and/or username,
 102 * __new__:  `getSessionToken()` method in `diaspy.connection.Connection` returns string from `_diaspora_session` cookie,
 103 * __new__:  `direct` parameter in `diaspy.connection.Connection().get()` allowing to disable pod expansion,
 104
 105
 106 * __upd__:  if `Post()` is created with fetched comments, data will also be fetched as a dependency,
 107 * __upd__:  `id` argument type is now `int` (`diaspy.models.Post.__init__()`),
 108 * __upd__:  `Search().lookup_user()` renamed to `Search().lookupUser()`,
 109 * __upd__:  `diaspy.messages` renamed to `diaspy.conversations` (but will be accessible under both names for this and next release),
 110 * __upd__:  `LoginError` moved to `diaspy.errors`,
 111 * __upd__:  `TokenError` moved to `diaspy.errors`,
 112 * __upd__:  `diaspy.connection.Connection.podswitch()` gained two new positional arguments: `username` and `password`,
 113 * __upd__:  `aspect_id` renamed to `id` in `diaspy.streams.Aspects().remove()`,
 114
 115
 116 * __fix__:  fixed some bugs in regular expressions used by `diaspy` internals (html tag removal, so you get nicer notifications),
 117 * __fix__:  fixed authentication issues,
 118
 119
 120 ----
 121
 122 #### Version `0.4.0` (2013-08-20):
 123
 124 This release is **not backwards compatible with `0.3.x` line**! You'll have to check your code for corrections.
 125 Also, this release if first to officially released fork version.
 126
 127 * __dep__:  `diaspy.client` is officially deprecated (will be removed in `0.4.1`),
 128
 129
 130 * __upd__:  `diaspy.conversations` renamed to `diaspy.messages`,
 131 * __udp__:  `diaspy.conversations.Conversation` moved to `diaspy.models`,
 132
 133
 134 * __new__:  `diaspy.messages.Mailbox()` object representing diaspora\* mailbox,
 135
 136 ----
 137
 138 #### Version `0.3.2` (2013-08-20):
 139
 140 * __upd__:  `diaspy.connection.getUserData()` raises `DiaspyError` when it cannot find user data,
 141
 142
 143 * __rem__:  `diaspy.client.Client` must be explicitly imported,
 144
 145 ----
 146
 147 #### Version `0.3.1` (2013-07-12):
 148
 149 * __upd__:  `diaspy.people.sephandle()` raises `InvalidHandleError` instead of `UserError`
 150 * __upd__:  `models.Post()._fetch()` renamed to `_fetchdata()` (because of new `_fetchcomments()` method)
 151
 152
 153 * __new__:  `models.Comment()` object: wrapper for comments, not to be created manually
 154 * __new__:  `comments` parameter in `models.Post`: defines whether to fetch post's commets
 155 * __new__:  `connection.Connection` has new parameter in `__init__()`: it's `schema`
 156 * __new__:  `author()` method in `models.Post()`
 157
 158
 159 The new parameter in `connection.Connection` is useful when operating with handles.
 160 As handle does not contain schema (`http`, `https`, etc.) `_setlogin()` would raise an
 161 unhandled exception -- `requests.exceptions.MissingSchema`.
 162 Now, however, `Connection` will catch the exception, add missing schema and try once more.
 163 This parameter is provided to give programmers ability to manipulate it.
 164
 165 Also, now you can pass just `pod.example.com` as `pod` parameter. Less typing!
 166
 167 When it comes to posts, we are now able to fetch comments.
 168
 169 ----
 170
 171 #### Version `0.3.0` (2013-07-07):
 172
 173 First edition of Changelog for `diaspy`.
 174 Developers should update their code as version `0.3.0` may not be fully
 175 backwards compatible depending on how the code is written.
 176 If you always pass named arguments and do not rely on their order you can, at least in
 177 theory, not worry about this update.
 178
 179 Version `0.3.0` introduces few new features, fixes several bugs and brings a bit of
 180 redesign and refactoring od `diaspy`'s code.
 181
 182 &nbsp;