Make ipfshhtpclient an optional library / backend for ethpm

- This change affects the different ipfs backends of ethpm. - Update docs to reference how to install the optional web3 install extra to utilize the ipfs backends.
ethereum · Nov 22, 2022 · 2db5b31 · 2db5b31
1 parent 92325e2
commit 2db5b31
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/docs/ethpm.rst b/docs/ethpm.rst
@@ -169,7 +169,16 @@ BaseURIBackend
 IPFS
 ~~~~
 
-``Py-EthPM`` has multiple backends available to fetch/pin files to IPFS. The desired backend can be set via the environment variable: ``ETHPM_IPFS_BACKEND_CLASS``.
+``Py-EthPM`` has multiple backends available to fetch/pin files to IPFS.
+The IPFS backends rely on the now-unmaintained ``ipfshttpclient`` library. Because of
+this, they are opt-in and may be installed via the ``ipfs`` web3 install extra.
+
+.. code-block:: bash
+
+    $ pip install "web3[ipfs]"
+
+
+The desired backend can be set via the environment variable: ``ETHPM_IPFS_BACKEND_CLASS``.
 
 - ``InfuraIPFSBackend`` (default)
     - `https://ipfs.infura.io`

diff --git a/newsfragments/2730.breaking.rst b/newsfragments/2730.breaking.rst
@@ -0,0 +1 @@
+Make the ``ipfshttpclient`` library and, thus, the ``ethpm`` ipfs backends opt-in via a web3 install extra.
diff --git a/setup.py b/setup.py
@@ -51,12 +51,16 @@
         "pluggy==0.13.1",
         "when-changed>=0.3.0",
     ],
+    "ipfs": [
+        "ipfshttpclient==0.8.0a2",
+    ],
 }
 
 extras_require["dev"] = (
     extras_require["tester"]
     + extras_require["linter"]
     + extras_require["docs"]
+    + extras_require["ipfs"]
     + extras_require["dev"]
 )
 
@@ -82,7 +86,6 @@
         "eth-typing>=3.0.0",
         "eth-utils>=2.0.0",
         "hexbytes>=0.1.0",
-        "ipfshttpclient==0.8.0a2",
         "jsonschema>=4.0.0",
         "lru-dict>=1.1.6",
         "protobuf>=4.21.6",