.travis.yml

@@ -9,17 +9,17 @@ matrix:
     env: TOXENV=py35
   - python: "3.6"
     env: TOXENV=py36
-  - python: "3.6"
-    env: TOXENV=codestyle
-    before_install: true
+  - python: "3.7"
+    dist: xenial
+    env: TOXENV=py37
 
 before_install:
-  - wget "https://dist.ipfs.io/go-ipfs/v0.4.14/go-ipfs_v0.4.14_linux-amd64.tar.gz" -O /tmp/ipfs.tar.gz
+  - wget "https://dist.ipfs.io/go-ipfs/v0.4.18/go-ipfs_v0.4.18_linux-amd64.tar.gz" -O /tmp/ipfs.tar.gz
   - mkdir -p $HOME/bin
   - pushd . && cd $HOME/bin && tar -xzvf /tmp/ipfs.tar.gz && popd
   - export PATH="$HOME/bin/go-ipfs:$PATH"
 
 install:
   - pip install tox
 
-script: tox
+script: tox

README.md

@@ -4,18 +4,14 @@
 [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 [![](https://img.shields.io/pypi/v/ipfsapi.svg?style=flat-square)](https://pypi.python.org/pypi/ipfsapi)
-[![Build Status](https://travis-ci.org/ipfs/py-ipfs-api.svg?branch=master)](https://travis-ci.org/ipfs/py-ipfs-api)
 
 ![Python IPFS HTTP Client Library](https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse)
 
-Check out [the client API reference](https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfsapi/) for the full command reference.
+## Deprecation Notice
 
-**Important:** The `py-ipfs-api` PIP package and Python module have both been renamed to `ipfsapi` (no dash, lower-case `a`).  
-The legacy `ipfs-api`/`ipfsApi` package/module will only work for IPFS 0.3.x and Python 2 and is deprecated. [Please upgrade](#important-changes-from-ipfsapi-02x)!
+**Important:** The `ipfsapi` PIP package and Python module have both been renamed to `ipfshttpclient` and this library has been converted into a thin wrapper around that other library. Only critical bug-fixes will be accepted for this package. Please see [migration notes on the new package](https://github.com/ipfs/py-ipfs-http-client/blob/master/README.md#important-changes-from-ipfsapi-04x) for details on how to proceed.
 
-**Note:** This library constantly has to change to stay compatible with the IPFS HTTP API.
-Currently, this library is tested against [go-ipfs v0.4.10](https://github.com/ipfs/go-ipfs/releases/tag/v0.4.10).
-You may experience compatibility issues when attempting to use it with other versions of go-ipfs.
+*The remainder of this README remains as a historical curiousity and will not be updated anymore.*
 
 ## Table of Contents
 

docs/api_ref.md

@@ -1,7 +1,7 @@
-Client API Reference
+Client API Reference
 --------------------
 
-All commands are accessed through the `ipfsapi.Client` class.
+All commands are accessed through the ``ipfsapi.Client`` class.
 
 ### Exceptions
 
@@ -14,7 +14,7 @@ All commands are accessed through the `ipfsapi.Client` class.
 
 ### The API Client
 
-All methods accept the following parameters in their `kwargs`:
+All methods accept the following parameters in their ``kwargs``:
 
  * **opts** (*dict*) – A dictonary of custom parameters to be sent with the
                        HTTP request

docs/conf.py

@@ -44,13 +44,9 @@
     'sphinx.ext.viewcode',
 ]
 
-import recommonmark
-from recommonmark.parser    import CommonMarkParser
-from recommonmark.transform import AutoStructify
-
 # Use reCommonMark for parsing text documents as MarkDown
 source_parsers = {
-    '.md': CommonMarkParser
+    '.md': 'recommonmark.parser.CommonMarkParser',
 }
 
 # Add any paths that contain templates here, relative to this directory.
@@ -162,7 +158,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -364,6 +360,7 @@
 
 # app setup hook for reCommonMark's AutoStructify
 def setup(app):
+	from recommonmark.transform import AutoStructify
 	app.add_config_value('recommonmark_config', {
 			'auto_toc_tree_section': 'Contents',
 		}, True)

docs/releasing.md

@@ -1,24 +1,18 @@
 Since releasing new versions is currently a somewhat complicated task, the current procedure
-(07.08.2017) will be outlined in this document.
+(27.04.2018) will be outlined in this document.
 
-All of this has only been tested on Debian 9 & Fedora 26 (Linux).
+All of this has only been tested on Debian 10 & Fedora 28 (Linux).
 
 # Prerequirements
 
 ## Building and updating the project
 
-### Python 3 with `setuptools` and `wheel` support
+### Python 3 with the `flit` project manager
 
-APT line: `sudo apt install python3-setuptools python3-wheel`  
-DNF line: `sudo dnf install python3-setuptools python3-wheel`
+APT line: `sudo apt install python3-pip && sudo pip3 install flit`  
+DNF line: `sudo dnf install python3-flit`
 
-### PanDoc
-
-PanDoc is used to on-the-fly convert the `README.md` to reStructuredText when running `./setup.py`.
-This way we can keep all the project documentation in one (nice) format.
-
-APT line: `sudo apt install pandoc`  
-DNF line: `sudo dnf install pandoc`
+*Note*: Version `1.0+` of `flit` is required!
 
 ## Building the documentation
 
@@ -62,9 +56,7 @@ You can download it at:
 
 ## Upload the new version to PyPI
 
-Run: `./setup.py sdist bdist_wheel upload`
-
-**You must have `pandoc` installed or the description PyPI will be replaced with nothingness!**
+Run: `flit build && flit upload`
 
 ## Re-generate the documentation
 

ipfsapi/__init__.py

@@ -2,6 +2,15 @@
 
 from __future__ import absolute_import
 
+import warnings
+warnings.warn(
+	"The `ipfsapi` library is deprecated and will stop receiving updates on "
+	"the 31.12.2019! If you are on Python 3.5+ please enable and fix all "
+	"Python deprecation warnings (CPython flag `-Wd`) and switch to the new "
+	"`ipfshttpclient` library name. Python 2.7 and 3.4 will not be supported "
+	"by the new library, so please upgrade.", FutureWarning, stacklevel=2
+)
+
 from .version import __version__
 
 ###########################

ipfsapi/client/__init__.py

@@ -0,0 +1,309 @@
+# -*- coding: utf-8 -*-
+"""IPFS API Bindings for Python.
+
+Classes:
+
+ * Client – a TCP client for interacting with an IPFS daemon
+"""
+from __future__ import absolute_import
+
+import functools
+import inspect
+import os
+import re
+import warnings
+try:  #PY3
+	import urllib.parse
+except ImportError:  #PY2
+	class urllib:
+		import urlparse as parse
+
+import ipfshttpclient
+import netaddr
+
+DEFAULT_HOST = str(os.environ.get("PY_IPFSAPI_DEFAULT_HOST", 'localhost'))
+DEFAULT_PORT = int(os.environ.get("PY_IPFSAPI_DEFAULT_PORT", 5001))
+DEFAULT_BASE = str(os.environ.get("PY_IPFSAPI_DEFAULT_BASE", 'api/v0'))
+
+VERSION_MINIMUM = "0.4.3"
+VERSION_MAXIMUM = "0.5.0"
+
+from .. import exceptions, encoding
+
+from . import base
+
+
+def assert_version(version, minimum=VERSION_MINIMUM, maximum=VERSION_MAXIMUM):
+	"""Make sure that the given daemon version is supported by this client
+	version.
+
+	Raises
+	------
+	~ipfsapi.exceptions.VersionMismatch
+
+	Parameters
+	----------
+	version : str
+		The version of an IPFS daemon.
+	minimum : str
+		The minimal IPFS version to allow.
+	maximum : str
+		The maximum IPFS version to allow.
+	"""
+	# Convert version strings to integer tuples
+	version = list(map(int, version.split('-', 1)[0].split('.')))
+	minimum = list(map(int, minimum.split('-', 1)[0].split('.')))
+	maximum = list(map(int, maximum.split('-', 1)[0].split('.')))
+
+	if minimum > version or version >= maximum:
+		raise exceptions.VersionMismatch(version, minimum, maximum)
+
+
+def connect(host=DEFAULT_HOST, port=DEFAULT_PORT, base=DEFAULT_BASE,
+            chunk_size=4096, **defaults):
+	"""Create a new :class:`~ipfsapi.Client` instance and connect to the
+	daemon to validate that its version is supported.
+
+	Raises
+	------
+	~ipfsapi.exceptions.VersionMismatch
+	~ipfsapi.exceptions.ErrorResponse
+	~ipfsapi.exceptions.ConnectionError
+	~ipfsapi.exceptions.ProtocolError
+	~ipfsapi.exceptions.StatusError
+	~ipfsapi.exceptions.TimeoutError
+
+
+	All parameters are identical to those passed to the constructor of the
+	:class:`~ipfsapi.Client` class.
+
+	Returns
+	-------
+		~ipfsapi.Client
+	"""
+	# Create client instance
+	client = Client(host, port, base, chunk_size, **defaults)
+
+	# Query version number from daemon and validate it
+	assert_version(client.version()['Version'])
+
+	return client
+
+
+class Client(ipfshttpclient.Client):
+	# Aliases for previous method names
+	key_gen    = base.DeprecatedMethodProperty("key", "gen")
+	key_list   = base.DeprecatedMethodProperty("key", "list")
+	key_rename = base.DeprecatedMethodProperty("key", "rename")
+	key_rm     = base.DeprecatedMethodProperty("key", "rm")
+
+	block_get  = base.DeprecatedMethodProperty("block", "get")
+	block_put  = base.DeprecatedMethodProperty("block", "put")
+	block_stat = base.DeprecatedMethodProperty("block", "stat")
+
+	files_cp    = base.DeprecatedMethodProperty("files", "cp")
+	files_ls    = base.DeprecatedMethodProperty("files", "ls")
+	files_mkdir = base.DeprecatedMethodProperty("files", "mkdir")
+	files_stat  = base.DeprecatedMethodProperty("files", "stat")
+	files_rm    = base.DeprecatedMethodProperty("files", "rm")
+	files_read  = base.DeprecatedMethodProperty("files", "read")
+	files_write = base.DeprecatedMethodProperty("files", "write")
+	files_mv    = base.DeprecatedMethodProperty("files", "mv")
+
+	object_data  = base.DeprecatedMethodProperty("object", "data")
+	object_get   = base.DeprecatedMethodProperty("object", "get")
+	object_links = base.DeprecatedMethodProperty("object", "links")
+	object_new   = base.DeprecatedMethodProperty("object", "new")
+	object_put   = base.DeprecatedMethodProperty("object", "put")
+	object_stat  = base.DeprecatedMethodProperty("object", "stat")
+	object_patch_add_link    = base.DeprecatedMethodProperty("object", "patch", "add_link")
+	object_patch_append_data = base.DeprecatedMethodProperty("object", "patch", "append_data")
+	object_patch_rm_link     = base.DeprecatedMethodProperty("object", "patch", "rm_link")
+	object_patch_set_data    = base.DeprecatedMethodProperty("object", "patch", "set_data")
+
+	pin_add    = base.DeprecatedMethodProperty("pin", "add")
+	pin_ls     = base.DeprecatedMethodProperty("pin", "ls")
+	pin_rm     = base.DeprecatedMethodProperty("pin", "rm")
+	pin_update = base.DeprecatedMethodProperty("pin", "update")
+	pin_verify = base.DeprecatedMethodProperty("pin", "verify")
+
+	refs       = base.DeprecatedMethodProperty("unstable", "refs")
+	refs_local = base.DeprecatedMethodProperty("unstable", "refs", "local")
+
+	bootstrap_add  = base.DeprecatedMethodProperty("bootstrap", "add")
+	bootstrap_list = base.DeprecatedMethodProperty("bootstrap", "list")
+	bootstrap_rm   = base.DeprecatedMethodProperty("bootstrap", "rm")
+
+	bitswap_stat     = base.DeprecatedMethodProperty("bitswap", "stat")
+	bitswap_wantlist = base.DeprecatedMethodProperty("bitswap", "wantlist")
+
+	dht_findpeer  = base.DeprecatedMethodProperty("dht", "findpeer")
+	dht_findprovs = base.DeprecatedMethodProperty("dht", "findproves")
+	dht_get       = base.DeprecatedMethodProperty("dht", "get")
+	dht_put       = base.DeprecatedMethodProperty("dht", "put")
+	dht_query     = base.DeprecatedMethodProperty("dht", "query")
+
+	pubsub_ls    = base.DeprecatedMethodProperty("pubsub", "ls")
+	pubsub_peers = base.DeprecatedMethodProperty("pubsub", "peers")
+	pubsub_pub   = base.DeprecatedMethodProperty("pubsub", "publish")
+	pubsub_sub   = base.DeprecatedMethodProperty("pubsub", "subscribe")
+
+	swarm_addrs      = base.DeprecatedMethodProperty("swarm", "addrs")
+	swarm_connect    = base.DeprecatedMethodProperty("swarm", "connect")
+	swarm_disconnect = base.DeprecatedMethodProperty("swarm", "disconnect")
+	swarm_peers      = base.DeprecatedMethodProperty("swarm", "peers")
+	swarm_filters_add = base.DeprecatedMethodProperty("swarm", "filters", "add")
+	swarm_filters_rm  = base.DeprecatedMethodProperty("swarm", "filters", "rm")
+
+	name_publish = base.DeprecatedMethodProperty("name", "publish")
+	name_resolve = base.DeprecatedMethodProperty("name", "resolve")
+
+	repo_gc   = base.DeprecatedMethodProperty("repo", "gc")
+	repo_stat = base.DeprecatedMethodProperty("repo", "stat")
+
+	config         = base.DeprecatedMethodProperty("config", "set")
+	config_show    = base.DeprecatedMethodProperty("config", "get")
+	config_replace = base.DeprecatedMethodProperty("config", "replace")
+
+	log_level = base.DeprecatedMethodProperty("unstable", "log", "level")
+	log_ls    = base.DeprecatedMethodProperty("unstable", "log", "ls")
+	log_tail  = base.DeprecatedMethodProperty("unstable", "log", "tail")
+
+	shutdown = base.DeprecatedMethodProperty("stop")
+
+
+	def __init__(self, host=DEFAULT_HOST, port=DEFAULT_PORT, base=DEFAULT_BASE,
+	             chunk_size=4096, **defaults):
+		# Assemble and parse the URL these parameters are supposed to represent
+		if not re.match('^https?://', host.lower()):
+			host = 'http://' + host
+		url = urllib.parse.urlsplit('%s:%s/%s' % (host, port, base))
+
+		# Detect whether `host` is a (DNS) hostname or an IP address
+		host_type = "dns"
+		try:
+			host_type = "ip{0}".format(netaddr.IPAddress(url.hostname).version)
+		except netaddr.AddrFormatError:
+			pass
+
+		addr = "/{0}/{1}/tcp/{2}/{3}".format(host_type, url.hostname, url.port, url.scheme)
+		super(Client, self).__init__(addr, base, chunk_size, timeout=None, **defaults)
+
+
+	def __getattribute__(self, name):
+		value = super(Client, self).__getattribute__(name)
+		if inspect.ismethod(value):
+			@functools.wraps(value)
+			def wrapper(*args, **kwargs):
+				# Rewrite changed named parameter names
+				if "multihash" in kwargs:
+					kwargs["cid"] = kwargs.pop("multihash")
+				if "multihashes" in kwargs:
+					kwargs["cids"] = kwargs.pop("multihashes")
+
+				try:
+					return value(*args, **kwargs)
+				# Partial error responses used to incorrectly just return
+				# the parts that were successfully received followed by the
+				# (undetected) error frame
+				except exceptions.PartialErrorResponse as error:
+					return error.partial + [{"Type": "error", "Message": str(error)}]
+			return wrapper
+		return value
+
+
+	def add(self, files, recursive=False, pattern='**', *args, **kwargs):
+		# Signature changed to: add(self, *files, recursive=False, pattern='**', **kwargs)
+		if not isinstance(files, (list, tuple)):
+			files = (files,)
+		return super(Client, self).add(*files, recursive=recursive, pattern=pattern, **kwargs)
+
+
+	# Dropped API methods
+	def bitswap_unwant(self, key, **kwargs):
+		"""Deprecated method: Do not use anymore"""
+		warnings.warn(
+			"IPFS API function “bitswap_unwant” support has been dropped "
+			"from go-ipfs", FutureWarning
+		)
+
+		args = (key,)
+		return self._client.request('/bitswap/unwant', args, **kwargs)
+
+
+	def file_ls(self, multihash, **kwargs):
+		"""Deprecated method: Replace usages with the similar “client.ls”"""
+		warnings.warn(
+			"IPFS API function “file_ls” support is highly deprecated and will "
+			"be removed soon from go-ipfs, use plain “ls” instead", FutureWarning
+		)
+
+		args = (multihash,)
+		return self._client.request('/file/ls', args, decoder='json', **kwargs)
+
+
+	# Dropped utility methods
+	def add_pyobj(self, py_obj, **kwargs):
+		"""Adds a picklable Python object as a file to IPFS.
+
+		.. deprecated:: 0.4.2
+		   The ``*_pyobj`` APIs allow for arbitrary code execution if abused.
+		   Either switch to :meth:`~ipfsapi.Client.add_json` or use
+		   ``client.add_bytes(pickle.dumps(py_obj))`` instead.
+
+		Please see :meth:`~ipfsapi.Client.get_pyobj` for the
+		**security risks** of using these methods!
+
+		.. code-block:: python
+
+			>>> c.add_pyobj([0, 1.0, 2j, '3', 4e5])
+			'QmWgXZSUTNNDD8LdkdJ8UXSn55KfFnNvTP1r7SyaQd74Ji'
+
+		Parameters
+		----------
+		py_obj : object
+			A picklable Python object
+
+		Returns
+		-------
+			str : Hash of the added IPFS object
+		"""
+		warnings.warn("Using `*_pyobj` on untrusted data is a security risk",
+		              DeprecationWarning)
+		return self.add_bytes(encoding.Pickle().encode(py_obj), **kwargs)
+
+	def get_pyobj(self, multihash, **kwargs):
+		"""Loads a pickled Python object from IPFS.
+
+		.. deprecated:: 0.4.2
+		   The ``*_pyobj`` APIs allow for arbitrary code execution if abused.
+		   Either switch to :meth:`~ipfsapi.Client.get_json` or use
+		   ``pickle.loads(client.cat(multihash))`` instead.
+
+		.. caution::
+
+			The pickle module is not intended to be secure against erroneous or
+			maliciously constructed data. Never unpickle data received from an
+			untrusted or unauthenticated source.
+
+			Please **read**
+			`this article <https://www.cs.uic.edu/%7Es/musings/pickle/>`_ to
+			understand the security risks of using this method!
+
+		.. code-block:: python
+
+			>>> c.get_pyobj('QmWgXZSUTNNDD8LdkdJ8UXSn55KfFnNvTP1r7SyaQd74Ji')
+			[0, 1.0, 2j, '3', 400000.0]
+
+		Parameters
+		----------
+		multihash : str
+			Multihash of the IPFS object to load
+
+		Returns
+		-------
+			object : Deserialized IPFS Python object
+		"""
+		warnings.warn("Using `*_pyobj` on untrusted data is a security risk",
+		              DeprecationWarning)
+		return encoding.Pickle().parse(self.cat(multihash, **kwargs))

ipfsapi/client/base.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import
+
+import warnings
+
+from . import DEFAULT_HOST, DEFAULT_PORT, DEFAULT_BASE
+
+
+class DeprecatedMethodProperty(object):
+	def __init__(self, *path, **kwargs):
+		#PY2: No support for kw-only parameters after glob parameters
+		prefix = kwargs.pop("prefix", [])
+		strip  = kwargs.pop("strip", 0)
+		assert not kwargs
+
+		self.props  = path
+		self.path   = tuple(prefix) + (path[:-strip] if strip > 0 else tuple(path))
+		self.warned = False
+
+		self.__help__ = "Deprecated method: Please use “client.{0}” instead".format(
+			".".join(self.path)
+		)
+
+	def __get__(self, obj, type=None):
+		if not self.warned:
+			message = "IPFS API function “{0}” has been renamed to “{1}”".format(
+				"_".join(self.path), ".".join(self.path)
+			)
+			warnings.warn(message, FutureWarning)
+			self.warned = True
+
+		for name in self.props:
+			print(name, obj)
+			obj = getattr(obj, name)
+		return obj

ipfsapi/exceptions.py

@@ -16,107 +16,19 @@
           +-- TimeoutError
 
 """
-
-
-class Error(Exception):
-    """Base class for all exceptions in this module."""
-    pass
-
-
-class VersionMismatch(Error):
-    """Raised when daemon version is not supported by this client version."""
-
-    def __init__(self, current, minimum, maximum):
-        self.current = current
-        self.minimum = minimum
-        self.maximum = maximum
-
-        msg = "Unsupported daemon version '{}' (not in range: {} – {})".format(
-            current, minimum, maximum
-        )
-        Error.__init__(self, msg)
-
-
-###############
-# encoding.py #
-###############
-class EncoderError(Error):
-    """Base class for all encoding and decoding related errors."""
-
-    def __init__(self, message, encoder_name):
-        self.encoder_name = encoder_name
-
-        Error.__init__(self, message)
-
-
-class EncoderMissingError(EncoderError):
-    """Raised when a requested encoder class does not actually exist."""
-
-    def __init__(self, encoder_name):
-        msg = "Unknown encoder: '{}'".format(encoder_name)
-        EncoderError.__init__(self, msg, encoder_name)
-
-
-class EncodingError(EncoderError):
-    """Raised when encoding a Python object into a byte string has failed
-    due to some problem with the input data."""
-
-    def __init__(self, encoder_name, original):
-        self.original = original
-
-        msg = "Object encoding error: {}".format(original)
-        EncoderError.__init__(self, msg, encoder_name)
-
-
-class DecodingError(EncoderError):
-    """Raised when decoding a byte string to a Python object has failed due to
-    some problem with the input data."""
-
-    def __init__(self, encoder_name, original):
-        self.original = original
-
-        msg = "Object decoding error: {}".format(original)
-        EncoderError.__init__(self, msg, encoder_name)
-
-
-###########
-# http.py #
-###########
-class CommunicationError(Error):
-    """Base class for all network communication related errors."""
-
-    def __init__(self, original, _message=None):
-        self.original = original
-
-        if _message:
-            msg = _message
-        else:
-            msg = "{}: {}".format(original.__class__.__name__, str(original))
-        Error.__init__(self, msg)
-
-
-class ProtocolError(CommunicationError):
-    """Raised when parsing the response from the daemon has failed.
-
-    This can most likely occur if the service on the remote end isn't in fact
-    an IPFS daemon."""
-
-
-class StatusError(CommunicationError):
-    """Raised when the daemon responds with an error to our request."""
-
-
-class ErrorResponse(StatusError):
-    """Raised when the daemon has responded with an error message because the
-    requested operation could not be carried out."""
-
-    def __init__(self, message, original):
-        StatusError.__init__(self, original, message)
-
-
-class ConnectionError(CommunicationError):
-    """Raised when connecting to the service has failed on the socket layer."""
-
-
-class TimeoutError(CommunicationError):
-    """Raised when the daemon didn't respond in time."""
+# Delegate list of exceptions to `ipfshttpclient`
+from ipfshttpclient.exceptions import *
+__all__ = [
+	"Error",
+	"VersionMismatch",
+	"EncoderError",
+	"EncoderMissingError",
+	"EncodingError",
+	"DecodingError",
+	"CommunicationError",
+	"ProtocolError",
+	"StatusError",
+	"ErrorResponse",
+	"ConnectionError",
+	"TimeoutError"
+]

ipfsapi/version.py

@@ -8,4 +8,4 @@
 # `0.4.1` and so on. When IPFS `0.5.0` is released, the first client version
 # to support it will also be released as `0.5.0`.
 
-__version__ = "0.4.2"
+__version__ = "0.4.4"

pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["flit"]
+build-backend = "flit.buildapi"
+
+[tool.flit.metadata]
+module = "ipfsapi"
+
+author       = "py-ipfs-api team"
+author-email = ""
+home-page    = "https://github.com/ipfs/py-ipfs-http-client/tree/py-ipfs-api"
+keywords     = "ipfs storage distribution development"
+license      = "MIT License"
+description-file = "README.md"
+
+# Unfortunately these currently need to be duplicated from `requirements.txt`
+requires-python = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*"
+requires = [
+	"ipfshttpclient>=0.4.10,<0.5.0",
+	"netaddr",
+	"six"
+]
+
+classifiers = [
+	"Development Status :: 3 - Alpha",
+
+	# Indicate who your project is intended for
+	"Intended Audience :: Developers",
+	"Intended Audience :: Information Technology",
+	"Intended Audience :: Science/Research",
+
+	"Topic :: Internet",
+	"Topic :: Scientific/Engineering",
+	"Topic :: System :: Filesystems",
+	"Topic :: System :: Networking",
+
+	# Pick your license as you wish (should match "license" above)
+	"License :: OSI Approved :: MIT License",
+
+	# Specify the Python versions you support here. In particular, ensure
+	# that you indicate whether you support Python 2, Python 3 or both.
+	"Programming Language :: Python :: 2",
+	"Programming Language :: Python :: 2.7",
+	"Programming Language :: Python :: 3",
+	"Programming Language :: Python :: 3.4",
+	"Programming Language :: Python :: 3.5",
+	"Programming Language :: Python :: 3.6"
+]
+
+[tool.flit.metadata.urls]
+Documentation = "https://ipfs.io/ipns/12D3KooWEqnTdgqHnkkwarSrJjeMP2ZJiADWLYADaNvUb6SQNyPF/docs/"
+

requirements-codestyle.txt

@@ -1 +1,2 @@
 flake8
+flake8-expandtab~=0.3

requirements-testing.txt

@@ -1,6 +1,3 @@
-httmock
 pathlib ; python_version < "3.4"
 pytest
-pytest-cov
-pytest-mock
 pytest-ordering

requirements.txt

@@ -1,2 +1,3 @@
-requests>=2.2.1
-six
+ipfshttpclient>=0.4.10,<0.5.0
+netaddr
+six

test/functional/tests.py

@@ -360,7 +360,7 @@ def test_get_path(self):
         try:
             test_hash = self.fake[8]['Hash'] + '/fsdfgh'
 
-            self.api.get(test_hash)
+            self.api.get(multihash=test_hash)
             assert 'fsdfgh' in os.listdir(os.getcwd())
 
             os.remove('fsdfgh')
@@ -386,6 +386,18 @@ def test_cat_single_file_str(self):
         finally:
             self._clean_up_pins()
 
+    def test_cat_file_block(self):
+        self.api.add(self.fake_file)
+
+        content = b"dsadsad\n"
+        try:
+            for offset in range(len(content)):
+                for length in range(len(content)):
+                    block = self.api.cat('QmQcCtMgLVwvMQGu6mvsRYLjwqrZJcYtH4mboM9urWW9vX', offset=offset, length=length)
+                    assert block == content[offset:offset+length]
+        finally:
+            self._clean_up_pins()
+
 
 @skipIfOffline()
 class IpfsApiLogTest(unittest.TestCase):
@@ -610,7 +622,7 @@ def setUp(self):
 
     def test_block_stat(self):
         expected_keys = ['Key', 'Size']
-        res = self.api.block_stat(self.multihash)
+        res = self.api.block_stat(multihash=self.multihash)
         for key in expected_keys:
             self.assertTrue(key in res)
 
@@ -821,15 +833,6 @@ def test_bitswap_stat(self):
         result = self.api.bitswap_stat()
         self.assertTrue(result and type(result) is dict and 'Wantlist' in result)
 
-    def test_bitswap_unwant(self):
-        """
-        Cannot ensure what is present in the wantlist prior to execution, so just ensure
-        something comes back.
-        """
-
-        result = self.api.bitswap_unwant(key='QmZTR5bcpQD7cFgTorqxZDYaew1Wqgfbd2ud9QqGPAkK2V')
-        self.assertTrue(result is not None)
-
 @skipIfOffline()
 class IpfsApiPubSubTest(unittest.TestCase):
 

test/run-tests.py

@@ -103,16 +103,12 @@ def _contextlib_suppress(*exceptions):
 	os.environ["CI"] = "true"
 
 	# Make sure all required py.test plugins are loaded
-	os.environ["PYTEST_PLUGINS"] = ",".join(["pytest_cov", "pytest_ordering"])
+	os.environ["PYTEST_PLUGINS"] = ",".join(["pytest_ordering"])
 
 	# Launch py.test in-process
 	import pytest
 	PYTEST_CODE = pytest.main([
-		"--verbose",
-		"--cov=ipfsapi",
-		"--cov-report=term",
-		"--cov-report=html:{}".format(str(TEST_PATH / "cov_html")),
-		"--cov-report=xml:{}".format(str(TEST_PATH / "cov.xml"))
+		"--verbose"
 	] + sys.argv[1:])
 finally:
 	# Make sure daemon was terminated during the tests

test/unit/test_encoding.py

@@ -10,7 +10,6 @@
 
 import pytest
 import six
-from httmock import urlmatch, HTTMock
 
 import ipfsapi.encoding
 import ipfsapi.exceptions

tox.ini

@@ -4,7 +4,8 @@ envlist =
 	py27,
 	py34,
 	py35,
-	py36
+	py36,
+	py37
 
 # Tox' sdist feature presumes that `./setup.py sdist` is available
 # Disable this feature until PEP-517 is implemented by both tox and flit.
@@ -27,17 +28,27 @@ commands =
 	flake8 {posargs}
 
 [flake8]
-ignore = E222,E221,F403,E265
-exclude = .venv,.git,.tox,+junk,dist,doc,*egg,build,tools,test,docs,*__init__.py
+exclude = .git,.tox,+junk,dist,doc,*egg,build,tools,test,docs,*__init__.py
+
+# E221: Multiple spaces before operator
+# E222: Multiple spaces after operator
+# E262: Inline comment should start with '# ': Breaks tagged comments (ie: '#TODO: ')
+# E265: Block comment should start with '# ':  ^
+# E303: More than 2 consecutive newlines
+# W292: No newline at end of file
+# W391: Blank line at end of file (sometimes trigged instead of the above!?)
+# F403: `from <module> import *` used; unable to detect undefined names ←– Probably should be fixed…
+ignore = E221,E222,E262,E265,E303,W292,W391,F403
+max-line-length = 100
+tab-width = 4
 
 [pytest]
 python_files =
 	test_*.py
 	*_test.py
 	tests.py
 addopts =
-	--doctest-modules
-	--ignore ipfsapi/client.py
+#   --doctest-modules / Totally useless since it cannot properly check the `client` package
 	ipfsapi
 	test/unit
 	test/functional