open-aea-cli-ipfs 2.2.0__tar.gz → 2.2.1__tar.gz

{open_aea_cli_ipfs-2.2.0/open_aea_cli_ipfs.egg-info → open_aea_cli_ipfs-2.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: open-aea-cli-ipfs
-Version: 2.2.0
+Version: 2.2.1
 Summary: CLI extension for open AEA framework wrapping IPFS functionality.
 Author: Valory AG
 License: Apache-2.0
@@ -39,4 +39,62 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-CLI extension for open AEA framework wrapping IPFS functionality.
+# AEA CLI IPFS Plug-in
+
+IPFS command to publish and download directories.
+
+## Installation and usage
+
+Make sure you have `aea` installed.
+
+Then, install the plug-in:
+``` bash
+pip install aea-cli-ipfs
+```
+
+Now you should be able to run `aea ipfs`.
+
+``` bash
+Usage: aea ipfs [OPTIONS] COMMAND [ARGS]...
+
+  IPFS Commands
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  add       Add directory to ipfs, if not directory specified the current...
+  download  Download directory by it's hash, if not target directory...
+  remove    Remove a directory from ipfs by it's hash.
+
+
+
+Usage: aea ipfs add [OPTIONS] [DIR_PATH]
+
+  Add directory to ipfs, if not directory specified the current one will be
+  added.
+
+Options:
+  -p, --publish
+  --help         Show this message and exit.
+
+
+
+Usage: aea ipfs remove [OPTIONS] hash_id
+
+  Remove a directory from ipfs by it's hash.
+
+Options:
+  --help  Show this message and exit.
+
+
+
+Usage: aea ipfs download [OPTIONS] hash_id [TARGET_DIR]
+
+  Download directory by it's hash, if not target directory specified will
+  use current one.
+
+Options:
+  --help  Show this message and exit.
+
+```

{open_aea_cli_ipfs-2.2.0 → open_aea_cli_ipfs-2.2.1/open_aea_cli_ipfs.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: open-aea-cli-ipfs
-Version: 2.2.0
+Version: 2.2.1
 Summary: CLI extension for open AEA framework wrapping IPFS functionality.
 Author: Valory AG
 License: Apache-2.0
@@ -39,4 +39,62 @@ Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary
 
-CLI extension for open AEA framework wrapping IPFS functionality.
+# AEA CLI IPFS Plug-in
+
+IPFS command to publish and download directories.
+
+## Installation and usage
+
+Make sure you have `aea` installed.
+
+Then, install the plug-in:
+``` bash
+pip install aea-cli-ipfs
+```
+
+Now you should be able to run `aea ipfs`.
+
+``` bash
+Usage: aea ipfs [OPTIONS] COMMAND [ARGS]...
+
+  IPFS Commands
+
+Options:
+  --help  Show this message and exit.
+
+Commands:
+  add       Add directory to ipfs, if not directory specified the current...
+  download  Download directory by it's hash, if not target directory...
+  remove    Remove a directory from ipfs by it's hash.
+
+
+
+Usage: aea ipfs add [OPTIONS] [DIR_PATH]
+
+  Add directory to ipfs, if not directory specified the current one will be
+  added.
+
+Options:
+  -p, --publish
+  --help         Show this message and exit.
+
+
+
+Usage: aea ipfs remove [OPTIONS] hash_id
+
+  Remove a directory from ipfs by it's hash.
+
+Options:
+  --help  Show this message and exit.
+
+
+
+Usage: aea ipfs download [OPTIONS] hash_id [TARGET_DIR]
+
+  Download directory by it's hash, if not target directory specified will
+  use current one.
+
+Options:
+  --help  Show this message and exit.
+
+```

{open_aea_cli_ipfs-2.2.0 → open_aea_cli_ipfs-2.2.1}/setup.py

@@ -22,15 +22,23 @@
 
 """Setup script for the plug-in."""
 
+from pathlib import Path
+
 from setuptools import find_packages, setup  # type: ignore
 
+
+def _read_long_description() -> str:
+    """Read the plugin README as the PyPI long description."""
+    return (Path(__file__).parent / "README.md").read_text(encoding="utf-8")
+
+
 setup(
     name="open-aea-cli-ipfs",
-    version="2.2.0",
+    version="2.2.1",
     author="Valory AG",
     license="Apache-2.0",
     description="CLI extension for open AEA framework wrapping IPFS functionality.",
-    long_description="CLI extension for open AEA framework wrapping IPFS functionality.",
+    long_description=_read_long_description(),
     long_description_content_type="text/markdown",
     packages=find_packages(include=["aea_cli_ipfs*"]),
     package_data={"aea_cli_ipfs": ["py.typed"]},