Commit | Line | Data |
---|---|---|
4285c996 | 1 | ## Changelog for `diaspy`, unofficial DIASPORA\* interface for Python |
6d8d47ce MM |
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 | ||
b74513c5 MM |
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 | ||
6d8d47ce | 27 | |
f61c14c1 MM |
28 | ---- |
29 | ||
73a9e0d3 | 30 | #### Version `0.4.1` (2013-09-): |
f61c14c1 | 31 | |
2cf8467c MM |
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 | ||
73a9e0d3 MM |
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 | ||
3def6e18 MM |
43 | |
44 | **`0.4.1-rc.3` (2013-09-08):** | |
45 | ||
46 | * __new__: `diaspy.settings.Profile.load()` method for loading profile information, | |
47 | * __new__: `diaspy.settings.Profile.update()` method for updating profile information, | |
48 | * __new__: `diaspy.settings.Profile.setName()` method, | |
49 | * __new__: `diaspy.settings.Profile.setBio()` method, | |
50 | * __new__: `diaspy.settings.Profile.setLocation()` method, | |
51 | * __new__: `diaspy.settings.Profile.setTags()` method, | |
52 | * __new__: `diaspy.settings.Profile.setGender()` method, | |
53 | * __new__: `diaspy.settings.Profile.setBirthDate()` method, | |
54 | * __new__: `diaspy.settings.Profile.setSearchable()` method, | |
55 | * __new__: `diaspy.settings.Profile.setNSFW()` method, | |
56 | ||
57 | ||
cf6a800f MM |
58 | **`0.4.1-rc.2` (2013-09-06):** |
59 | ||
60 | * __new__: `diaspy.search.Search.tags()` method for getting tag suggestions, | |
b74513c5 MM |
61 | * __new__: `diaspy.settings.Profile.getName()` method, |
62 | * __new__: `diaspy.settings.Profile.getBio()` method, | |
63 | * __new__: `diaspy.settings.Profile.getLocation()` method, | |
f91374ce | 64 | * __new__: `diaspy.settings.Profile.getTags()` method, |
b74513c5 MM |
65 | * __new__: `diaspy.settings.Profile.getGender()` method, |
66 | * __new__: `diaspy.settings.Profile.getBirthDate()` method, | |
67 | * __new__: `diaspy.settings.Profile.isSearchable()` method, | |
68 | * __new__: `diaspy.settings.Profile.isNSFW()` method, | |
f91374ce | 69 | * __new__: `provider_display_name` parameter in `diaspy.streams.Stream.post()` (thanks @svbergerem), |
cf6a800f | 70 | |
3def6e18 | 71 | |
a90eb458 MM |
72 | * __upd__: `remeber_me` parameter in `diaspy.connection.Connection.login()`, |
73 | * __upd__: you must supply `username` and `password` parameters on init of `diaspy.connection.Connection`, | |
b74513c5 MM |
74 | * __upd__: you must update your testconf.py (new fields are required for settings tests), |
75 | * __upd__: `diaspy.settings.Settings` renamed to `diaspy.settings.Account`, | |
a90eb458 | 76 | |
3def6e18 | 77 | |
a90eb458 MM |
78 | * __rem__: `username` and `password` parameters removed from `diaspy.connection.Connection.login()` |
79 | must be supplied on init, | |
80 | ||
cf6a800f | 81 | |
73a9e0d3 | 82 | **`0.4.1-rc.1` (2013-09-02):** |
2cf8467c | 83 | |
f61c14c1 | 84 | * __new__: `__getitem__()` in `diaspy.models.Post`, |
fe783229 MM |
85 | * __new__: `__dict__()` in `diaspy.models.Post`, |
86 | * __new__: `guid` argument in `diaspy.models.Post.__init__()`, | |
f61c14c1 MM |
87 | * __new__: `json()` method in `diaspy.streams.Generic` adds the possibility to export streams to JSON, |
88 | * __new__: `full()` method in `diaspy.streams.Generic` will try to fetch full stream (containing all posts), | |
89 | * __new__: `setEmail()` method in `diaspy.settings.Settings`, | |
90 | * __new__: `setLanguage()` method in `diaspy.settings.Settings`, | |
91 | * __new__: `downloadPhotos()` method in `diaspy.settings.Settings`, | |
fe783229 | 92 | * __new__: `backtime` argument in `more()` method in `diaspy.streams.Generic`, |
2cf8467c | 93 | * __new__: `DiaspyError` will be raised when connection is created with empty password and/or username, |
73a9e0d3 MM |
94 | * __new__: `getSessionToken()` method in `diaspy.connection.Connection` returns string from `_diaspora_session` cookie, |
95 | * __new__: `direct` parameter in `diaspy.connection.Connection().get()` allowing to disable pod expansion, | |
fe783229 | 96 | |
3def6e18 | 97 | |
fe783229 MM |
98 | * __upd__: if `Post()` is created with fetched comments, data will also be fetched as a dependency, |
99 | * __upd__: `id` argument type is now `int` (`diaspy.models.Post.__init__()`), | |
51ab5af5 | 100 | * __upd__: `Search().lookup_user()` renamed to `Search().lookupUser()`, |
3a509ff5 | 101 | * __upd__: `diaspy.messages` renamed to `diaspy.conversations` (but will be accessible under both names for this and next release), |
2cf8467c MM |
102 | * __upd__: `LoginError` moved to `diaspy.errors`, |
103 | * __upd__: `TokenError` moved to `diaspy.errors`, | |
104 | * __upd__: `diaspy.connection.Connection.podswitch()` gained two new positional arguments: `username` and `password`, | |
73a9e0d3 | 105 | * __upd__: `aspect_id` renamed to `id` in `diaspy.streams.Aspects().remove()`, |
f61c14c1 | 106 | |
3def6e18 MM |
107 | |
108 | * __fix__: fixed some bugs in regular expressions used by `diaspy` internals (html tag removal, so you get nicer notifications), | |
5de52803 | 109 | * __fix__: fixed authentication issues, |
f61c14c1 MM |
110 | |
111 | ||
1cff2093 MM |
112 | ---- |
113 | ||
4882952f MM |
114 | #### Version `0.4.0` (2013-08-20): |
115 | ||
116 | This release is **not backwards compatible with `0.3.x` line**! You'll have to check your code for corrections. | |
117 | Also, this release if first to officially released fork version. | |
118 | ||
119 | * __dep__: `diaspy.client` is officially deprecated (will be removed in `0.4.1`), | |
120 | ||
3def6e18 | 121 | |
4882952f MM |
122 | * __upd__: `diaspy.conversations` renamed to `diaspy.messages`, |
123 | * __udp__: `diaspy.conversations.Conversation` moved to `diaspy.models`, | |
124 | ||
3def6e18 | 125 | |
4882952f MM |
126 | * __new__: `diaspy.messages.Mailbox()` object representing diaspora\* mailbox, |
127 | ||
128 | ---- | |
129 | ||
3def6e18 | 130 | #### Version `0.3.2` (2013-08-20): |
1cff2093 MM |
131 | |
132 | * __upd__: `diaspy.connection.getUserData()` raises `DiaspyError` when it cannot find user data, | |
133 | ||
3def6e18 | 134 | |
33735129 MM |
135 | * __rem__: `diaspy.client.Client` must be explicitly imported, |
136 | ||
615edb73 MM |
137 | ---- |
138 | ||
3def6e18 | 139 | #### Version `0.3.1` (2013-07-12): |
615edb73 MM |
140 | |
141 | * __upd__: `diaspy.people.sephandle()` raises `InvalidHandleError` instead of `UserError` | |
63f1d9f1 | 142 | * __upd__: `models.Post()._fetch()` renamed to `_fetchdata()` (because of new `_fetchcomments()` method) |
3def6e18 MM |
143 | |
144 | ||
313fb305 MM |
145 | * __new__: `models.Comment()` object: wrapper for comments, not to be created manually |
146 | * __new__: `comments` parameter in `models.Post`: defines whether to fetch post's commets | |
615edb73 | 147 | * __new__: `connection.Connection` has new parameter in `__init__()`: it's `schema` |
313fb305 | 148 | * __new__: `author()` method in `models.Post()` |
615edb73 MM |
149 | |
150 | ||
151 | The new parameter in `connection.Connection` is useful when operating with handles. | |
152 | As handle does not contain schema (`http`, `https`, etc.) `_setlogin()` would raise an | |
153 | unhandled exception -- `requests.exceptions.MissingSchema`. | |
154 | Now, however, `Connection` will catch the exception, add missing schema and try once more. | |
155 | This parameter is provided to give programmers ability to manipulate it. | |
156 | ||
157 | Also, now you can pass just `pod.example.com` as `pod` parameter. Less typing! | |
158 | ||
313fb305 MM |
159 | When it comes to posts, we are now able to fetch comments. |
160 | ||
6d8d47ce MM |
161 | ---- |
162 | ||
3def6e18 | 163 | #### Version `0.3.0` (2013-07-07): |
6d8d47ce | 164 | |
cf0105fb MM |
165 | First edition of Changelog for `diaspy`. |
166 | Developers should update their code as version `0.3.0` may not be fully | |
167 | backwards compatible depending on how the code is written. | |
168 | If you always pass named arguments and do not rely on their order you can, at least in | |
169 | theory, not worry about this update. | |
170 | ||
171 | Version `0.3.0` introduces few new features, fixes several bugs and brings a bit of | |
172 | redesign and refactoring od `diaspy`'s code. | |
173 | ||
3def6e18 | 174 | |