Skip to content

Commit 6a133e3

Browse files
c0llab0rat0rntninja
authored andcommitted
Change version marker from 0.7.0 to 0.8.0a1; fix spelling and grammar issues in readme
1 parent 91bdaba commit 6a133e3

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

CHANGELOG.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,21 @@ py-ipfs-http-client 0.X.X (XX.XX.20XX)
33

44
* (None yet)
55

6-
py-ipfs-http-client 0.8.0 (XX.XX.20XX)
7-
--------------------------------------
6+
7+
py-ipfs-http-client 0.8.0a1 (11.05.2021)
8+
----------------------------------------
89

910
* py-ipfs-api-client will now only warn when detecting an unsupported daemon version
1011
* Rationale: During the 0.4.x series the library required many changes to stay compatible
1112
with the respective daemon version, but since 0.5.0 appears to be no longer the case
12-
* Compatiblity bumped to go-IPFS 0.8.x (by Jan Rydzewski and other community members bugging me)
13-
13+
* Compatibility bumped to go-IPFS 0.8.x (by Jan Rydzewski and other community members bugging me)
14+
1415
**Breaking changes in this release**:
1516

1617
* Dropped support for the (previously deprecated) `return_result` parameter of `.repo.gc(…)`
1718
* Dropped support for the previously deprecated and always undocumented `return_result` parameter everywhere else
19+
* Dropped support for go-IPFS 0.4.x; minimum supported version now 0.5.0
20+
1821

1922
py-ipfs-http-client 0.7.0 (15.03.2021)
2023
--------------------------------------
@@ -26,7 +29,7 @@ py-ipfs-http-client 0.7.0a1 (14.10.2020)
2629
--------------------------------------
2730

2831
* Added support for optional arguments of the `.dag.*` APIs (by João Meyer)
29-
* Compatiblity bumped to go-IPFS 0.7.x (by Jan Rydzewski and other community members bugging me)
32+
* Compatibility bumped to go-IPFS 0.7.x (by Jan Rydzewski and other community members bugging me)
3033
* The 0.7 series is not stable yet, expect some breaking changes before the final release!
3134

3235

@@ -51,7 +54,7 @@ py-ipfs-http-client 0.6.0 (30.06.2020)
5154

5255
**Breaking changes in this release**:
5356

54-
* The *recursive* parameter of `.add()` is no longer ignored and now enforces its default value of `False` (explicitely set it to `True` for the previous behaviour)
57+
* The *recursive* parameter of `.add()` is no longer ignored and now enforces its default value of `False` (explicitly set it to `True` for the previous behaviour)
5558
* The glob pattern strings that may be passed to the `.add()` pattern parameter now actually behave like recursive glob patterns (see [the Python documentation](https://docs.python.org/3/library/glob.html) for how exactly)
5659
* Most functions previously returning a dict with the raw JSON response, now return a custom mapping type instead
5760
* This mapping type supports the original getitem syntax (`result["ItemName"]`) unchanged, but if you need an actual dictionary object you need to call `.as_json()` on it
@@ -62,9 +65,9 @@ Other changes:
6265

6366
* Added support for go-IPFS 0.5.x
6467
* Adding directories with `.add()` has been greatly reworked:
65-
* Its now possible to specify arbitrary rules on which objects to include a directory tree by passing a custom matcher object to the *pattern* parameter
66-
* The new *period_special* parameter allows toggling whether glob patterns match dot-files implicietly and defaults to `True` (previously it was effectively `False`)
67-
* The new *follow_symlinks* parameter similarily determines whether symbolic links will be followed when scanning directory trees and defaults to `False` (the previous default on Unix, albeit this likely wasn't intentional)
68+
* It's now possible to specify arbitrary rules on which objects to include a directory tree by passing a custom matcher object to the *pattern* parameter
69+
* The new *period_special* parameter allows toggling whether glob patterns match dot-files implicitly and defaults to `True` (previously it was effectively `False`)
70+
* The new *follow_symlinks* parameter similarly determines whether symbolic links will be followed when scanning directory trees and defaults to `False` (the previous default on Unix, albeit this likely wasn't intentional)
6871
* `.add()` will now limit its scan to the directories required to match the given glob patterns (passing in regular expression objects will still scan the tree unconditionally however) – custom matchers have full control over which directories are visited
6972
* The requests-based HTTP backend has been supplemented by another backend based on [HTTPx](https://www.python-httpx.org/) for Python 3.6+
7073
* Due to a minor limitation within the library (no ability to apply address family restrictions during name resolution) this currently included as a preview and must be manually enabled, to do this ensure that the `httpx` library is installed in your Python environment and run your program with the environment variable *PY_IPFS_HTTP_CLIENT_PREFER_HTTPX* set to *yes*.
@@ -86,22 +89,22 @@ This release features several breaking changes, as compared to the previous *py-
8689

8790
* A new import name: `ipfsapi``ipfshttpclient` (thanks to @AlibabasMerchant)
8891
* The client API is now structured according to the [IPFS interface core specification](https://github.com/ipfs/interface-ipfs-core/tree/master/SPEC)
89-
* Deamon location is now described using [Multiaddr](https://github.com/multiformats/multiaddr)
92+
* Daemon location is now described using [Multiaddr](https://github.com/multiformats/multiaddr)
9093
* Some deprecated methods have been dropped:
9194
* `bitswap_unwant`: API endpoint dropped by *go-ipfs*
9295
* `{get,set}_pyobj`: Can too easily be abused for abitrary code execution, use `pickle.{loads,dumps}` if you really need this
9396
* `file_ls`: Long deprecated by *go-ipfs* and scheduled for removal, use plain `ls` instead
9497

9598
Some new features added in this release:
9699

97-
* Adding large directories doesn't read them all into memory anymore before sending them to the daemon
100+
* Adding large directories doesn't read them all into memory any more before sending them to the daemon
98101
* API documentation has been improved
99102
* TCP connections may now be reused between API requests
100-
* `.add_json` now adds data as UTF-8 rather than using Unicode-escapes for shorter/more-canoncial data representation (thanks to @emmnx)
103+
* `.add_json` now adds data as UTF-8 rather than using Unicode-escapes for shorter/more canonical data representation (thanks to @emmnx)
101104
* Several parameters have been added to existing methods:
102105
* Using [filestore](https://github.com/ipfs-filestore/go-ipfs/tree/master/filestore) is now possible (thanks to @radfish)
103106
* Universal per-call `offline` parameter added (thanks to @radfish)
104-
* Universal per-call `return_result` parameter added to issue `HEAD` requests and surpress results for speeds (thanks to @loardcirth)
107+
* Universal per-call `return_result` parameter added to issue `HEAD` requests and suppress results for speeds (thanks to @loardcirth)
105108
* Universal per-call `timeout` parameter added (thanks to @AlibabasMerchant)
106109
* `.add`: `nocopy` & `raw_leaves` (thanks to @radfish)
107110
* `.ls`: `paths` (thanks to @radfish)

ipfshttpclient/version.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@
88
# `0.4.1` and so on. When IPFS `0.5.0` is released, the first client version
99
# to support it will also be released as `0.5.0`.
1010

11-
__version__ = "0.7.0"
11+
__version__ = "0.8.0a1"
12+

0 commit comments

Comments
 (0)