projects / diaspy.git / blame
| Commit | Line | Data |
|---|---|---|
| 6d8d47ce MM |
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 | ||
| f61c14c1 MM |
22 | ---- |
| 23 | ||
| 24 | #### Version `0.4.1` (2013-08-): | |
| 25 | ||
| 26 | * __new__: `__getitem__()` in `diaspy.models.Post`, | |
| fe783229 MM |
27 | * __new__: `__dict__()` in `diaspy.models.Post`, |
| 28 | * __new__: `guid` argument in `diaspy.models.Post.__init__()`, | |
| f61c14c1 MM |
29 | * __new__: `json()` method in `diaspy.streams.Generic` adds the possibility to export streams to JSON, |
| 30 | * __new__: `full()` method in `diaspy.streams.Generic` will try to fetch full stream (containing all posts), | |
| 31 | * __new__: `setEmail()` method in `diaspy.settings.Settings`, | |
| 32 | * __new__: `setLanguage()` method in `diaspy.settings.Settings`, | |
| 33 | * __new__: `downloadPhotos()` method in `diaspy.settings.Settings`, | |
| fe783229 MM |
34 | * __new__: `backtime` argument in `more()` method in `diaspy.streams.Generic`, |
| 35 | ||
| 36 | * __upd__: if `Post()` is created with fetched comments, data will also be fetched as a dependency, | |
| 37 | * __upd__: `id` argument type is now `int` (`diaspy.models.Post.__init__()`), | |
| 51ab5af5 | 38 | * __upd__: `Search().lookup_user()` renamed to `Search().lookupUser()`, |
| 3a509ff5 | 39 | * __upd__: `diaspy.messages` renamed to `diaspy.conversations` (but will be accessible under both names for this and next release), |
| f61c14c1 MM |
40 | |
| 41 | * __fix__: fixed some bugs in regular expressions used by `diaspy` internals | |
| 42 | (html tag removal, so you get nicer notifications), | |
| 43 | ||
| 44 | ||
| 1cff2093 MM |
45 | ---- |
| 46 | ||
| 4882952f MM |
47 | #### Version `0.4.0` (2013-08-20): |
| 48 | ||
| 49 | This release is **not backwards compatible with `0.3.x` line**! You'll have to check your code for corrections. | |
| 50 | Also, this release if first to officially released fork version. | |
| 51 | ||
| 52 | * __dep__: `diaspy.client` is officially deprecated (will be removed in `0.4.1`), | |
| 53 | ||
| 54 | * __upd__: `diaspy.conversations` renamed to `diaspy.messages`, | |
| 55 | * __udp__: `diaspy.conversations.Conversation` moved to `diaspy.models`, | |
| 56 | ||
| 57 | * __new__: `diaspy.messages.Mailbox()` object representing diaspora\* mailbox, | |
| 58 | ||
| 59 | ---- | |
| 60 | ||
| 61 | Version `0.3.2` (2013-08-20): | |
| 1cff2093 MM |
62 | |
| 63 | * __upd__: `diaspy.connection.getUserData()` raises `DiaspyError` when it cannot find user data, | |
| 64 | ||
| 33735129 MM |
65 | * __rem__: `diaspy.client.Client` must be explicitly imported, |
| 66 | ||
| 615edb73 MM |
67 | ---- |
| 68 | ||
| 69 | Version `0.3.1` (2013-07-12): | |
| 70 | ||
| 71 | * __upd__: `diaspy.people.sephandle()` raises `InvalidHandleError` instead of `UserError` | |
| 63f1d9f1 | 72 | * __upd__: `models.Post()._fetch()` renamed to `_fetchdata()` (because of new `_fetchcomments()` method) |
| 313fb305 MM |
73 | * __new__: `models.Comment()` object: wrapper for comments, not to be created manually |
| 74 | * __new__: `comments` parameter in `models.Post`: defines whether to fetch post's commets | |
| 615edb73 | 75 | * __new__: `connection.Connection` has new parameter in `__init__()`: it's `schema` |
| 313fb305 | 76 | * __new__: `author()` method in `models.Post()` |
| 615edb73 MM |
77 | |
| 78 | ||
| 79 | The new parameter in `connection.Connection` is useful when operating with handles. | |
| 80 | As handle does not contain schema (`http`, `https`, etc.) `_setlogin()` would raise an | |
| 81 | unhandled exception -- `requests.exceptions.MissingSchema`. | |
| 82 | Now, however, `Connection` will catch the exception, add missing schema and try once more. | |
| 83 | This parameter is provided to give programmers ability to manipulate it. | |
| 84 | ||
| 85 | Also, now you can pass just `pod.example.com` as `pod` parameter. Less typing! | |
| 86 | ||
| 313fb305 MM |
87 | When it comes to posts, we are now able to fetch comments. |
| 88 | ||
| 6d8d47ce MM |
89 | ---- |
| 90 | ||
| 91 | Version `0.3.0` (2013-07-07): | |
| 92 | ||
| cf0105fb MM |
93 | First edition of Changelog for `diaspy`. |
| 94 | Developers should update their code as version `0.3.0` may not be fully | |
| 95 | backwards compatible depending on how the code is written. | |
| 96 | If you always pass named arguments and do not rely on their order you can, at least in | |
| 97 | theory, not worry about this update. | |
| 98 | ||
| 99 | Version `0.3.0` introduces few new features, fixes several bugs and brings a bit of | |
| 100 | redesign and refactoring od `diaspy`'s code. | |
| 101 | ||
| 102 | ---- |