You can fetch tag suggestions using diaspy
[diaspy.git] / Changelog.markdown
CommitLineData
4285c996 1## Changelog for `diaspy`, unofficial DIASPORA\* interface for Python
6d8d47ce
MM
2
3This 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
10Deprecation means that in the next version feature will be removed.
11
12Also, after every version there should be a brief note describing possible
13problems with migrating to it from older versions and usage of new features.
14
15Users can always read the manual and dcumentation to make themselves more knowledgeable and
16are encouraged to do so. They only need to remember that documentation is usually more
17up-to-date than manual and if conflicts appear they should follow the order:
18
19*docstrings* -> *docs/* -> *manual/*
20
21
f61c14c1
MM
22----
23
73a9e0d3 24#### Version `0.4.1` (2013-09-):
f61c14c1 25
2cf8467c
MM
26Login and authentication procedure backend received major changes in this version.
27There are no longer `username` and `password` variables in `Connection` object.
28Instead, credentials are stored (together with the token) in single variable `_login_data`.
29This is preserved until you call `login()` at which point credentials are erased and
30only token is left -- it can be obtained by calling `repr(Connection)`.
31
73a9e0d3
MM
32Also, this release is compatible with DIASPORA\* 0.2.0.0 but should still support
33pods running on older versions.
34
35And the test suite was updated. Yay!
36
cf6a800f
MM
37**`0.4.1-rc.2` (2013-09-06):**
38
39* __new__: `diaspy.search.Search.tags()` method for getting tag suggestions,
40
41
73a9e0d3 42**`0.4.1-rc.1` (2013-09-02):**
2cf8467c 43
f61c14c1 44* __new__: `__getitem__()` in `diaspy.models.Post`,
fe783229
MM
45* __new__: `__dict__()` in `diaspy.models.Post`,
46* __new__: `guid` argument in `diaspy.models.Post.__init__()`,
f61c14c1
MM
47* __new__: `json()` method in `diaspy.streams.Generic` adds the possibility to export streams to JSON,
48* __new__: `full()` method in `diaspy.streams.Generic` will try to fetch full stream (containing all posts),
49* __new__: `setEmail()` method in `diaspy.settings.Settings`,
50* __new__: `setLanguage()` method in `diaspy.settings.Settings`,
51* __new__: `downloadPhotos()` method in `diaspy.settings.Settings`,
fe783229 52* __new__: `backtime` argument in `more()` method in `diaspy.streams.Generic`,
2cf8467c 53* __new__: `DiaspyError` will be raised when connection is created with empty password and/or username,
73a9e0d3
MM
54* __new__: `getSessionToken()` method in `diaspy.connection.Connection` returns string from `_diaspora_session` cookie,
55* __new__: `direct` parameter in `diaspy.connection.Connection().get()` allowing to disable pod expansion,
fe783229
MM
56
57* __upd__: if `Post()` is created with fetched comments, data will also be fetched as a dependency,
58* __upd__: `id` argument type is now `int` (`diaspy.models.Post.__init__()`),
51ab5af5 59* __upd__: `Search().lookup_user()` renamed to `Search().lookupUser()`,
3a509ff5 60* __upd__: `diaspy.messages` renamed to `diaspy.conversations` (but will be accessible under both names for this and next release),
2cf8467c
MM
61* __upd__: `LoginError` moved to `diaspy.errors`,
62* __upd__: `TokenError` moved to `diaspy.errors`,
63* __upd__: `diaspy.connection.Connection.podswitch()` gained two new positional arguments: `username` and `password`,
73a9e0d3 64* __upd__: `aspect_id` renamed to `id` in `diaspy.streams.Aspects().remove()`,
f61c14c1
MM
65
66* __fix__: fixed some bugs in regular expressions used by `diaspy` internals
67 (html tag removal, so you get nicer notifications),
5de52803 68* __fix__: fixed authentication issues,
f61c14c1
MM
69
70
1cff2093
MM
71----
72
4882952f
MM
73#### Version `0.4.0` (2013-08-20):
74
75This release is **not backwards compatible with `0.3.x` line**! You'll have to check your code for corrections.
76Also, this release if first to officially released fork version.
77
78* __dep__: `diaspy.client` is officially deprecated (will be removed in `0.4.1`),
79
80* __upd__: `diaspy.conversations` renamed to `diaspy.messages`,
81* __udp__: `diaspy.conversations.Conversation` moved to `diaspy.models`,
82
83* __new__: `diaspy.messages.Mailbox()` object representing diaspora\* mailbox,
84
85----
86
87Version `0.3.2` (2013-08-20):
1cff2093
MM
88
89* __upd__: `diaspy.connection.getUserData()` raises `DiaspyError` when it cannot find user data,
90
33735129
MM
91* __rem__: `diaspy.client.Client` must be explicitly imported,
92
615edb73
MM
93----
94
95Version `0.3.1` (2013-07-12):
96
97* __upd__: `diaspy.people.sephandle()` raises `InvalidHandleError` instead of `UserError`
63f1d9f1 98* __upd__: `models.Post()._fetch()` renamed to `_fetchdata()` (because of new `_fetchcomments()` method)
313fb305
MM
99* __new__: `models.Comment()` object: wrapper for comments, not to be created manually
100* __new__: `comments` parameter in `models.Post`: defines whether to fetch post's commets
615edb73 101* __new__: `connection.Connection` has new parameter in `__init__()`: it's `schema`
313fb305 102* __new__: `author()` method in `models.Post()`
615edb73
MM
103
104
105The new parameter in `connection.Connection` is useful when operating with handles.
106As handle does not contain schema (`http`, `https`, etc.) `_setlogin()` would raise an
107unhandled exception -- `requests.exceptions.MissingSchema`.
108Now, however, `Connection` will catch the exception, add missing schema and try once more.
109This parameter is provided to give programmers ability to manipulate it.
110
111Also, now you can pass just `pod.example.com` as `pod` parameter. Less typing!
112
313fb305
MM
113When it comes to posts, we are now able to fetch comments.
114
6d8d47ce
MM
115----
116
117Version `0.3.0` (2013-07-07):
118
cf0105fb
MM
119First edition of Changelog for `diaspy`.
120Developers should update their code as version `0.3.0` may not be fully
121backwards compatible depending on how the code is written.
122If you always pass named arguments and do not rely on their order you can, at least in
123theory, not worry about this update.
124
125Version `0.3.0` introduces few new features, fixes several bugs and brings a bit of
126redesign and refactoring od `diaspy`'s code.
127
128----