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 | ||
1cff2093 MM |
22 | ---- |
23 | ||
24 | Version `0.3.2` (2013-08-): | |
25 | ||
26 | * __upd__: `diaspy.connection.getUserData()` raises `DiaspyError` when it cannot find user data, | |
27 | ||
33735129 MM |
28 | * __rem__: `diaspy.client.Client` must be explicitly imported, |
29 | ||
615edb73 MM |
30 | ---- |
31 | ||
32 | Version `0.3.1` (2013-07-12): | |
33 | ||
34 | * __upd__: `diaspy.people.sephandle()` raises `InvalidHandleError` instead of `UserError` | |
63f1d9f1 | 35 | * __upd__: `models.Post()._fetch()` renamed to `_fetchdata()` (because of new `_fetchcomments()` method) |
313fb305 MM |
36 | * __new__: `models.Comment()` object: wrapper for comments, not to be created manually |
37 | * __new__: `comments` parameter in `models.Post`: defines whether to fetch post's commets | |
615edb73 | 38 | * __new__: `connection.Connection` has new parameter in `__init__()`: it's `schema` |
313fb305 | 39 | * __new__: `author()` method in `models.Post()` |
615edb73 MM |
40 | |
41 | ||
42 | The new parameter in `connection.Connection` is useful when operating with handles. | |
43 | As handle does not contain schema (`http`, `https`, etc.) `_setlogin()` would raise an | |
44 | unhandled exception -- `requests.exceptions.MissingSchema`. | |
45 | Now, however, `Connection` will catch the exception, add missing schema and try once more. | |
46 | This parameter is provided to give programmers ability to manipulate it. | |
47 | ||
48 | Also, now you can pass just `pod.example.com` as `pod` parameter. Less typing! | |
49 | ||
313fb305 MM |
50 | When it comes to posts, we are now able to fetch comments. |
51 | ||
6d8d47ce MM |
52 | ---- |
53 | ||
54 | Version `0.3.0` (2013-07-07): | |
55 | ||
cf0105fb MM |
56 | First edition of Changelog for `diaspy`. |
57 | Developers should update their code as version `0.3.0` may not be fully | |
58 | backwards compatible depending on how the code is written. | |
59 | If you always pass named arguments and do not rely on their order you can, at least in | |
60 | theory, not worry about this update. | |
61 | ||
62 | Version `0.3.0` introduces few new features, fixes several bugs and brings a bit of | |
63 | redesign and refactoring od `diaspy`'s code. | |
64 | ||
65 | ---- |