Changelog.markdown

   1 ## Changelog for `diaspy`, unofficla Diaspora\* API 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
  24 #### Version `0.4.0` (2013-08-20):
  25
  26 This release is **not backwards compatible with `0.3.x` line**! You'll have to check your code for corrections.
  27 Also, this release if first to officially released fork version.
  28
  29 * __dep__:  `diaspy.client` is officially deprecated (will be removed in `0.4.1`),
  30
  31 * __upd__:  `diaspy.conversations` renamed to `diaspy.messages`,
  32 * __udp__:  `diaspy.conversations.Conversation` moved to `diaspy.models`,
  33
  34 * __new__:  `diaspy.messages.Mailbox()` object representing diaspora\* mailbox,
  35
  36 ----
  37
  38 Version `0.3.2` (2013-08-20):
  39
  40 * __upd__:  `diaspy.connection.getUserData()` raises `DiaspyError` when it cannot find user data,
  41
  42 * __rem__:  `diaspy.client.Client` must be explicitly imported,
  43
  44 ----
  45
  46 Version `0.3.1` (2013-07-12):
  47
  48 * __upd__:  `diaspy.people.sephandle()` raises `InvalidHandleError` instead of `UserError`
  49 * __upd__:  `models.Post()._fetch()` renamed to `_fetchdata()` (because of new `_fetchcomments()` method)
  50 * __new__:  `models.Comment()` object: wrapper for comments, not to be created manually
  51 * __new__:  `comments` parameter in `models.Post`: defines whether to fetch post's commets
  52 * __new__:  `connection.Connection` has new parameter in `__init__()`: it's `schema`
  53 * __new__:  `author()` method in `models.Post()`
  54
  55
  56 The new parameter in `connection.Connection` is useful when operating with handles.
  57 As handle does not contain schema (`http`, `https`, etc.) `_setlogin()` would raise an
  58 unhandled exception -- `requests.exceptions.MissingSchema`.
  59 Now, however, `Connection` will catch the exception, add missing schema and try once more.
  60 This parameter is provided to give programmers ability to manipulate it.
  61
  62 Also, now you can pass just `pod.example.com` as `pod` parameter. Less typing!
  63
  64 When it comes to posts, we are now able to fetch comments.
  65
  66 ----
  67
  68 Version `0.3.0` (2013-07-07):
  69
  70 First edition of Changelog for `diaspy`.
  71 Developers should update their code as version `0.3.0` may not be fully
  72 backwards compatible depending on how the code is written.
  73 If you always pass named arguments and do not rely on their order you can, at least in
  74 theory, not worry about this update.
  75
  76 Version `0.3.0` introduces few new features, fixes several bugs and brings a bit of
  77 redesign and refactoring od `diaspy`'s code.
  78
  79 ----