Compare commits
4 Commits
Author | SHA1 | Date | |
---|---|---|---|
55265e69a4
|
|||
dbfc68c396
|
|||
c3e2dfbd8e
|
|||
ce0a608db2
|
@ -1,7 +1,7 @@
|
||||
{
|
||||
"version": "0.2",
|
||||
"language": "en,en-gb",
|
||||
"ignoreWords": ["getframe", "pycache", "pydantic", "UNLCK"],
|
||||
"ignoreWords": ["followlinks", "getframe", "pycache", "pydantic", "UNLCK"],
|
||||
"words": [
|
||||
"chacl",
|
||||
"kikan",
|
||||
|
94
README.md
94
README.md
@ -4,7 +4,7 @@ The mdrs-client-python is python library and a command-line client for up- and d
|
||||
|
||||
## Installing
|
||||
|
||||
```
|
||||
```shell
|
||||
poetry install
|
||||
```
|
||||
|
||||
@ -14,141 +14,143 @@ poetry install
|
||||
|
||||
Create remote host configuration
|
||||
|
||||
```
|
||||
$ mdrs config create neurodata https://neurodata.riken.jp/api
|
||||
```shell
|
||||
mdrs config create neurodata https://neurodata.riken.jp/api
|
||||
```
|
||||
|
||||
### login
|
||||
|
||||
Login to remote host
|
||||
|
||||
```
|
||||
$ mdrs login neurodata:
|
||||
```shell
|
||||
mdrs login neurodata:
|
||||
Username: (enter your login name)
|
||||
Password: (enter your password)
|
||||
|
||||
mdrs login -u USERNAME -p PASSWORD neurodata:
|
||||
```
|
||||
|
||||
### logout
|
||||
|
||||
Logout from remote host
|
||||
|
||||
```
|
||||
$ mdrs logout neurodata:
|
||||
```shell
|
||||
mdrs logout neurodata:
|
||||
```
|
||||
|
||||
### whoami
|
||||
|
||||
Print current user name
|
||||
|
||||
```
|
||||
$ mdrs whoami neurodata:
|
||||
```shell
|
||||
mdrs whoami neurodata:
|
||||
```
|
||||
|
||||
### labs
|
||||
|
||||
List all laboratories
|
||||
|
||||
```
|
||||
$ mdrs labs neurodata:
|
||||
```shell
|
||||
mdrs labs neurodata:
|
||||
```
|
||||
|
||||
### ls
|
||||
|
||||
List the folder contents
|
||||
|
||||
```
|
||||
$ mdrs ls neurodata:/NIU/Repository/
|
||||
$ mdrs ls -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/
|
||||
$ mdrs ls -r neurodata:/NIU/Repository/Dataset1/
|
||||
$ mdrs ls -J -r neurodata:/NIU/Repository/Dataset1/
|
||||
```shell
|
||||
mdrs ls neurodata:/NIU/Repository/
|
||||
mdrs ls -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/
|
||||
mdrs ls -r neurodata:/NIU/Repository/Dataset1/
|
||||
mdrs ls -J -r neurodata:/NIU/Repository/Dataset1/
|
||||
```
|
||||
|
||||
### mkdir
|
||||
|
||||
Create a new folder
|
||||
|
||||
```
|
||||
$ mdrs mkdir neurodata:/NIU/Repository/TEST
|
||||
```shell
|
||||
mdrs mkdir neurodata:/NIU/Repository/TEST
|
||||
```
|
||||
|
||||
### upload
|
||||
|
||||
Upload the file or directory
|
||||
|
||||
```
|
||||
$ mdrs upload ./sample.dat neurodata:/NIU/Repository/TEST/
|
||||
$ mdrs upload -r ./dataset neurodata:/NIU/Repository/TEST/
|
||||
```shell
|
||||
mdrs upload ./sample.dat neurodata:/NIU/Repository/TEST/
|
||||
mdrs upload -r ./dataset neurodata:/NIU/Repository/TEST/
|
||||
```
|
||||
|
||||
### download
|
||||
|
||||
Download the file or folder
|
||||
|
||||
```
|
||||
$ mdrs download neurodata:/NIU/Repository/TEST/sample.dat ./
|
||||
$ mdrs download -r neurodata:/NIU/Repository/TEST/dataset/ ./
|
||||
$ mdrs download -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.dat ./
|
||||
```shell
|
||||
mdrs download neurodata:/NIU/Repository/TEST/sample.dat ./
|
||||
mdrs download -r neurodata:/NIU/Repository/TEST/dataset/ ./
|
||||
mdrs download -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.dat ./
|
||||
```
|
||||
|
||||
### mv
|
||||
|
||||
Move or rename the file or folder
|
||||
|
||||
```
|
||||
$ mdrs mv neurodata:/NIU/Repository/TEST/sample.dat neurodata:/NIU/Repository/TEST2/sample2.dat
|
||||
$ mdrs mv neurodata:/NIU/Repository/TEST/dataset neurodata:/NIU/Repository/TEST2/
|
||||
```shell
|
||||
mdrs mv neurodata:/NIU/Repository/TEST/sample.dat neurodata:/NIU/Repository/TEST2/sample2.dat
|
||||
mdrs mv neurodata:/NIU/Repository/TEST/dataset neurodata:/NIU/Repository/TEST2/
|
||||
```
|
||||
|
||||
### cp
|
||||
|
||||
Copy the file and folder
|
||||
|
||||
```
|
||||
$ mdrs cp neurodata:/NIU/Repository/TEST/sample.dat neurodata:/NIU/Repository/TEST2/sample2.dat
|
||||
$ mdrs cp -r neurodata:/NIU/Repository/TEST/dataset neurodata:/NIU/Repository/TEST2/
|
||||
```shell
|
||||
mdrs cp neurodata:/NIU/Repository/TEST/sample.dat neurodata:/NIU/Repository/TEST2/sample2.dat
|
||||
mdrs cp -r neurodata:/NIU/Repository/TEST/dataset neurodata:/NIU/Repository/TEST2/
|
||||
```
|
||||
|
||||
### rm
|
||||
|
||||
Remove the file or folder
|
||||
|
||||
```
|
||||
$ mdrs rm neurodata:/NIU/Repository/TEST2/sample2.dat
|
||||
$ mdrs rm -r neurodata:/NIU/Repository/TEST2/dataset
|
||||
```shell
|
||||
mdrs rm neurodata:/NIU/Repository/TEST2/sample2.dat
|
||||
mdrs rm -r neurodata:/NIU/Repository/TEST2/dataset
|
||||
```
|
||||
|
||||
### chacl
|
||||
|
||||
Change the folder access level
|
||||
|
||||
```
|
||||
$ mdrs chacl private neurodata:/NIU/Repository/Private
|
||||
$ mdrs chacl cbs_open -r neurodata:/NIU/Repository/CBS_Open
|
||||
$ mdrs chacl pw_open -r -p FOLDER_PASSWORD neurodata:/NIU/Repository/PW_Open
|
||||
```shell
|
||||
mdrs chacl private neurodata:/NIU/Repository/Private
|
||||
mdrs chacl cbs_open -r neurodata:/NIU/Repository/CBS_Open
|
||||
mdrs chacl pw_open -r -p FOLDER_PASSWORD neurodata:/NIU/Repository/PW_Open
|
||||
```
|
||||
|
||||
### metadata
|
||||
|
||||
Get a folder metadata
|
||||
|
||||
```
|
||||
$ mdrs metadata neurodata:/NIU/Repository/TEST/
|
||||
$ mdrs metadata -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/
|
||||
```shell
|
||||
mdrs metadata neurodata:/NIU/Repository/TEST/
|
||||
mdrs metadata -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/
|
||||
```
|
||||
|
||||
### file-metadata
|
||||
|
||||
Get the file metadata
|
||||
|
||||
```
|
||||
$ mdrs file-metadata neurodata:/NIU/Repository/TEST/dataset/sample.dat
|
||||
$ mdrs file-metadata -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.txt
|
||||
```shell
|
||||
mdrs file-metadata neurodata:/NIU/Repository/TEST/dataset/sample.dat
|
||||
mdrs file-metadata -p PW_OPEN_PASSWORD neurodata:/NIU/Repository/PW_Open/Readme.txt
|
||||
```
|
||||
|
||||
### help
|
||||
|
||||
Show the help message and exit
|
||||
|
||||
```
|
||||
$ mdrs -h
|
||||
```shell
|
||||
mdrs -h
|
||||
```
|
||||
|
@ -1 +1 @@
|
||||
1.3.0
|
||||
1.3.1
|
||||
|
@ -32,7 +32,7 @@ class FilesApi(BaseApi):
|
||||
token_check(self.connection)
|
||||
data: dict[str, str | int] = {"folder_id": folder_id}
|
||||
try:
|
||||
with open(os.path.relpath(path), mode="rb") as fp:
|
||||
with open(os.path.realpath(path), mode="rb") as fp:
|
||||
response = self.connection.post(url, data=data, files={"file": fp})
|
||||
self._raise_response_error(response)
|
||||
ret = TypeAdapter(FilesApiCreateResponse).validate_python(response.json())
|
||||
@ -47,7 +47,7 @@ class FilesApi(BaseApi):
|
||||
if path is not None:
|
||||
# update file body
|
||||
try:
|
||||
with open(os.path.relpath(path), mode="rb") as fp:
|
||||
with open(os.path.realpath(path), mode="rb") as fp:
|
||||
response = self.connection.put(url, files={"file": fp})
|
||||
except OSError:
|
||||
raise UnexpectedException(f"Could not open `{path}` file.")
|
||||
|
@ -13,14 +13,16 @@ class LoginCommand(BaseCommand):
|
||||
@classmethod
|
||||
def register(cls, parsers: Any) -> None:
|
||||
login_parser = parsers.add_parser("login", help="login to remote host")
|
||||
login_parser.add_argument("-u", "--username", help="login username")
|
||||
login_parser.add_argument("-p", "--password", help="login password")
|
||||
login_parser.add_argument("remote", help="label of remote host")
|
||||
login_parser.set_defaults(func=cls.func)
|
||||
|
||||
@classmethod
|
||||
def func(cls, args: Namespace) -> None:
|
||||
remote = str(args.remote)
|
||||
username = input("Username: ").strip()
|
||||
password = getpass.getpass("Password: ").strip()
|
||||
username = str(args.username) if args.password else input("Username: ").strip()
|
||||
password = str(args.password) if args.password else getpass.getpass("Password: ").strip()
|
||||
cls.login(remote, username, password)
|
||||
|
||||
@classmethod
|
||||
|
@ -26,6 +26,12 @@ class UploadCommand(BaseCommand):
|
||||
upload_parser.add_argument(
|
||||
"-r", "--recursive", help="upload directories and their contents recursive", action="store_true"
|
||||
)
|
||||
upload_parser.add_argument(
|
||||
"-s",
|
||||
"--skip-if-exists",
|
||||
help="skip the upload if file is already uploaded and file size is the same",
|
||||
action="store_true",
|
||||
)
|
||||
upload_parser.add_argument("local_path", help="local file path (/foo/bar/data.txt)")
|
||||
upload_parser.add_argument("remote_path", help="remote folder path (remote:/lab/path/)")
|
||||
upload_parser.set_defaults(func=cls.func)
|
||||
@ -35,12 +41,13 @@ class UploadCommand(BaseCommand):
|
||||
local_path = str(args.local_path)
|
||||
remote_path = str(args.remote_path)
|
||||
is_recursive = bool(args.recursive)
|
||||
cls.upload(local_path, remote_path, is_recursive)
|
||||
is_skip_if_exists = bool(args.skip_if_exists)
|
||||
cls.upload(local_path, remote_path, is_recursive, is_skip_if_exists)
|
||||
|
||||
@classmethod
|
||||
def upload(cls, local_path: str, remote_path: str, is_recursive: bool) -> None:
|
||||
def upload(cls, local_path: str, remote_path: str, is_recursive: bool, is_skip_if_exists: bool) -> None:
|
||||
(remote, laboratory_name, r_path) = cls._parse_remote_host_with_path(remote_path)
|
||||
l_path = local_path
|
||||
l_path = os.path.abspath(local_path)
|
||||
if not os.path.exists(l_path):
|
||||
raise IllegalArgumentException(f"File or directory `{local_path}` not found.")
|
||||
connection = cls._create_connection(remote)
|
||||
@ -54,8 +61,9 @@ class UploadCommand(BaseCommand):
|
||||
folder_map: dict[str, Folder] = {}
|
||||
folder_map[r_path] = folder
|
||||
l_basename = os.path.basename(l_path)
|
||||
for dirpath, _, filenames in os.walk(l_path):
|
||||
d_dirname = os.path.join(r_path, l_basename)
|
||||
for dirpath, _, filenames in os.walk(l_path, followlinks=True):
|
||||
sub = l_basename if dirpath == l_path else os.path.join(l_basename, os.path.relpath(dirpath, l_path))
|
||||
d_dirname = os.path.join(r_path, sub)
|
||||
d_basename = os.path.basename(d_dirname)
|
||||
# prepare destination parent path
|
||||
d_parent_dirname = os.path.dirname(d_dirname)
|
||||
@ -77,22 +85,24 @@ class UploadCommand(BaseCommand):
|
||||
infos.append(UploadFileInfo(folder_map[d_dirname], os.path.join(dirpath, filename)))
|
||||
else:
|
||||
infos.append(UploadFileInfo(folder, l_path))
|
||||
cls.__multiple_upload(connection, infos)
|
||||
cls.__multiple_upload(connection, infos, is_skip_if_exists)
|
||||
|
||||
@classmethod
|
||||
def __multiple_upload(cls, connection: MDRSConnection, infos: list[UploadFileInfo]) -> None:
|
||||
def __multiple_upload(
|
||||
cls, connection: MDRSConnection, infos: list[UploadFileInfo], is_skip_if_exists: bool
|
||||
) -> None:
|
||||
file_api = FilesApi(connection)
|
||||
with ThreadPoolExecutor(max_workers=CONCURRENT) as pool:
|
||||
pool.map(lambda x: cls.__multiple_upload_worker(file_api, x), infos)
|
||||
pool.map(lambda x: cls.__multiple_upload_worker(file_api, x, is_skip_if_exists), infos)
|
||||
|
||||
@classmethod
|
||||
def __multiple_upload_worker(cls, file_api: FilesApi, info: UploadFileInfo) -> None:
|
||||
def __multiple_upload_worker(cls, file_api: FilesApi, info: UploadFileInfo, is_skip_if_exists: bool) -> None:
|
||||
basename = os.path.basename(info.path)
|
||||
file = info.folder.find_file(basename)
|
||||
try:
|
||||
if file is None:
|
||||
file_api.create(info.folder.id, info.path)
|
||||
else:
|
||||
elif not is_skip_if_exists or file.size != os.path.getsize(info.path):
|
||||
file_api.update(file, info.path)
|
||||
print(os.path.join(info.folder.path, basename))
|
||||
except MDRSException as e:
|
||||
|
@ -1,6 +1,6 @@
|
||||
[tool.poetry]
|
||||
name = "mdrs-client-python"
|
||||
version = "1.3.0"
|
||||
version = "1.3.3"
|
||||
description = "The mdrs-client-python is python library and a command-line client for up- and downloading files to and from MDRS based repository."
|
||||
authors = ["Yoshihiro OKUMURA <yoshihiro.okumura@riken.jp>"]
|
||||
license = "MIT"
|
||||
@ -23,18 +23,18 @@ packages = [
|
||||
[tool.poetry.dependencies]
|
||||
python = "^3.10"
|
||||
requests = "^2.31.0"
|
||||
python-dotenv = "^1.0.0"
|
||||
pydantic = "^2.5.2"
|
||||
python-dotenv = "^1.0.1"
|
||||
pydantic = "^2.6.1"
|
||||
pydantic-settings = "^2.1.0"
|
||||
PyJWT = "^2.8.0"
|
||||
validators = "^0.22.0"
|
||||
|
||||
[tool.poetry.group.dev.dependencies]
|
||||
black = "^23.12.0"
|
||||
flake8 = "^6.1.0"
|
||||
black = "^24.2.0"
|
||||
flake8 = "^7.0.0"
|
||||
Flake8-pyproject = "^1.2.3"
|
||||
isort = "^5.13.0"
|
||||
pyright = "^1.1.339"
|
||||
isort = "^5.13.2"
|
||||
pyright = "^1.1.350"
|
||||
|
||||
[tool.poetry.scripts]
|
||||
mdrs = 'mdrsclient.__main__:main'
|
||||
|
Reference in New Issue
Block a user