This is an automated email from the ASF dual-hosted git repository.
dimuthuupe pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airavata-mft.git
The following commit(s) were added to refs/heads/master by this push:
new e28bd08 Update cli medata
e28bd08 is described below
commit e28bd083efc4f882ca8013274da5ee6dd5716e76
Author: DImuthuUpe <[email protected]>
AuthorDate: Thu Apr 6 13:22:07 2023 -0400
Update cli medata
---
python-cli/README.md | 11 +-----
python-cli/mft_cli/README.md | 77 ++++++++++++++++++++++++++++++++++++++-
python-cli/mft_cli/pyproject.toml | 14 +++++--
3 files changed, 89 insertions(+), 13 deletions(-)
diff --git a/python-cli/README.md b/python-cli/README.md
index 3a2639c..539309d 100644
--- a/python-cli/README.md
+++ b/python-cli/README.md
@@ -17,7 +17,7 @@ specific language governing permissions and limitations
under the License.
-->
-### MFT-Cli Build Instructions
+### MFT-Cli Local Build Instructions
Install Poetry
```
@@ -29,17 +29,10 @@ pip install pick
Load Poetry shell
```
-cd airavata_mft_cli
+cd mft_cli
poetry shell
```
-Install dependencies
-```
-pip install grpcio==1.46.3
-pip install grpcio-tools==1.46.3
-pip install airavata_mft_sdk==0.0.1-alpha26
-```
-
Build the binary
```
poetry install
diff --git a/python-cli/mft_cli/README.md b/python-cli/mft_cli/README.md
index af79dd7..d35cf56 100644
--- a/python-cli/mft_cli/README.md
+++ b/python-cli/mft_cli/README.md
@@ -17,4 +17,79 @@ specific language governing permissions and limitations
under the License.
-->
-# Airavata MFT Command Line Client
\ No newline at end of file
+# Airavata Managed File Transfers (MFT)
+
+Apache Airavata MFT is a high-performance, multi-protocol data transfer engine
to orchestrate data movement and operations across most cloud and On-premises
storages. MFT aims to abstract the complexity of heterogenous storages by
providing a unified and simple interface for users to seamlessly access and
move data across any storage endpoint. To accomplish this goal, MFT provides
simple but highly-performing tools to access most cloud and on-premise storages
as seamlessly as they access [...]
+
+Apache Airavata MFT bundles easily deployable agents that auto determine
optimum network path with additional multi-channel, parallel data paths to
optimize the transfer performance to gain the maximum throughput between
storage endpoints. MFT utilizes parallel Agents to transfer data between
endpoints to gain the advantage of multiple network links.
+
+# Try Airavata MFT
+MFT requires Java 11+ and python3.10+ to install Airavata MFT in your
environment. MFT currently supports Linux and MacOS operating systems.
Contributions to support Windows are welcome!!.
+
+### Download and Install
+
+Following commands will download Airavata MFT into your machine and start the
MFT service.
+```
+pip3 install airavata-mft-cli
+mft init
+```
+
+> If the installer failed for M1 and M2 Macs complaining about grpcio
installation. Follow the solution mentioned in
[here](https://github.com/apache/airavata-mft/issues/71). You might have to
uninstall already installed grpcio and grpcio-tools distributions first.
+> For other common installation issues, please refer to the [troubleshooting
section](https://github.com/apache/airavata-mft#common-issues).
+
+To stop MFT after using
+
+```
+mft stop
+```
+
+
+### Registering Storages
+
+First you need to register your storage endpoints into MFT in order to access
them. Registering storage is an interactive process and you can easily register
those without prior knowledge
+
+```
+mft storage add
+```
+
+This will ask the type of storage you need and credentials to access those
storages. To list already added storages, you can run
+
+```
+mft storage list
+```
+### Accessing Data in Storages
+
+In Airavata MFT, we provide a unified interface to access the data in any
storage. Users can access data in storages just as they access data in their
computers. MFT converts user queries into storage specific data representations
(POSIX, Block, Objects, ..) internally
+
+```
+mft ls <storage name>
+mft ls <storage name>/<resource path>
+```
+
+### Moving Data between Storages
+
+Copying data between storages are simple as copying data between directories
of local machine for users. MFT takes care of network path optimizations,
parallel data path selections and selections or creations of suitable transfer
agents.
+
+ ```
+ mft cp <source storage name>/<path> <destination storage name>/<path>
+ ```
+MFT is capable of auto detecting directory copying and file copying based on
the path given.
+
+### Troubleshooting and Issue Reporting
+
+This is our very first attempt release Airavata MFT for community usage and
there might be lots of corner cases that we have not noticed. All the logs of
MFT service are available in
```~/.mft/Standalone-Service-0.01/logs/airavata.log```. If you see any error
while using MFT, please report that in our Github issue page and we will
respond as soon as possible. We really appreciate your contribution as it will
greatly help to improve the stability of the product.
+
+#### Common issues
+
+- Following error can be noticed if you have a python version which is less
than 3.10
+```
+ ERROR: Could not find a version that satisfies the requirement
airavata-mft-cli (from versions: none)
+ ERROR: No matching distribution found for airavata-mft-cli
+```
+If the Error still occurs after installing the right python version, try
creating a virtual environemnt
+```
+python3.10 -m venv venv
+source venv/bin/activate
+pip install airavata-mft-cli
+```
+
diff --git a/python-cli/mft_cli/pyproject.toml
b/python-cli/mft_cli/pyproject.toml
index a6d8acd..fc1bf82 100644
--- a/python-cli/mft_cli/pyproject.toml
+++ b/python-cli/mft_cli/pyproject.toml
@@ -18,10 +18,18 @@
[tool.poetry]
name = "airavata-mft-cli"
-version = "0.1.9"
-description = "Command Line Client for Airavata MFT data transfer software"
-authors = ["Apache Airavata <[email protected]>"]
+version = "0.1.10"
+description = "Command Line Client for Apache Airavata MFT data transfer
software"
+authors = [
+ "Dimuthu Wannipurage <[email protected]>",
+]
+maintainers = [
+ "Apache Airavata Developers <[email protected]>",
+]
readme = "README.md"
+homepage = "https://github.com/apache/airavata-mft";
+license = "Apache-2.0"
+keywords = ["MFT", "Data", "High Thorught Data Transfer", "Multi Protocol",
"S3", "GCS", "Azure", "SCP", "Google Drive", "Swift", "Box", "DropBox"]
[tool.poetry.scripts]
mft = "airavata_mft_cli.main:app"
