{ "info": { "author": "LUMC, Jeroen F.J. Laros", "author_email": "J.F.J.Laros@lumc.nl", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Topic :: Scientific/Engineering" ], "description": "# Transfer client\nThis package provides functions for communication with the Restful Transfer\nServer.\n\n## Installation\nVia [pypi](https://pypi.python.org/pypi/transfer-client):\n\n pip install transfer_client\n\nFrom source:\n\n git clone https://git.lumc.nl/apis/transfer_client.git\n cd transfer_client\n pip install .\n\n### Server certificate\nIf the server uses a self-signed certificate, the administrator of the server\nneeds to add this certificate to the list of trusted authorities (change\n`server_name` and `domain`):\n\n openssl s_client -connect server_name.domain:443 < /dev/null | \\\n openssl x509 > /usr/local/share/ca-certificates/server_name.crt\n update-ca-certificates\n\n## Configuration\nThe client creates a configuration file named\n`.config/transfer_client/config.yml`. The `config` subcommand is used to\nmanipulate this file.\n\nIn the following example, we set the server to `server_name.domain`, add a\nproject named `test` and set this project as the default project.\n\n transfer_client config set server server_name.domain\n transfer_client config add test \"This is a placeholder.\"\n transfer_client config set project test\n\nBy default, JSON is used as output format, but YAML is supported as well.\n\n transfer_client config set output_format yaml\n\nIf the server certificate can not be installed, it might be convenient to\ndisable the SSL certificate check by default.\n\n transfer_client config set ssl_check false\n\nList of all configuration variables:\n\n transfer_client config defaults\n\nList all projects:\n\n transfer_client config projects\n\n## Command line interface\nUse the command `transfer_client -h` for a list of subcommands. For every\nsubcommand a separate help is available, e.g.,\n\n```\n$ transfer_client users -h\nusage: transfer_client users [-h] [-o OUTPUT] SERVER USER\n\nGives a JSON object of a user together with its transfers.\n\npositional arguments:\n SERVER server name\n USER user id\n\noptional arguments:\n -h, --help show this help message and exit\n -o OUTPUT output file\n -n disable ssl certificate check\n```\n\n### Typical usage\nThe following high level subcommands are probably the only ones needed.\n\nTo transfer a list of files, use the `transfer` subcommand. We assume that the\nserver name is `server_name.domain` and the user ID is `xxxxxxxx`.\n\n transfer_client transfer server_name.domain xxxxxxxx *.gz\n\nA directory including its subdirectories can be transferred as a gzipped\ntarfile in chunks of 10G with the `transfer_dir` command. The receiver will see\nthese chunks as files, together with a `README.md` containing unpacking\ninstructions.\n\n transfer_client transfer_dir server_name.domain xxxxxxxx directory\n\nAny (possibly required) additional metadata can be passed to these functions\nvia the `-a` parameter.\n\n transfer_client transfer -a other.json server_name.domain xxxxxxxx *.gz\n\nIf a transfer is interrupted for some reason, it can be resumed with the\n`resume` subcommand.\n\n transfer_client resume server_name.domain xxxxxxxx\n\nTo cancel an interrupted transfer, the `cancel` subcommand can be used.\n\n transfer_client cancel server_name.domain xxxxxxxx\n\n### Other JSON schemas\nThe client assumes the minimal JSON schema can be used. If this is not the\ncase, the metadata needs to be generated beforehand. This metadata is used in a\nseparate step to initiate the transfer with the `transfers` subcommand.\n\n tranfer_client transfers server_name.domain xxxxxxxx meta.json\n\nNow the `resume` command can be used to upload the data.\n\n transfer_client resume server_name.domain xxxxxxxx\n\n## Library\nThe library implements an interface to the API of the Restful Transfer server.\nFull documentation can be found [here](https://git.lumc.nl/j.k.vis/transfer).\n\n### Usage\nTo use the interface, we first make a class instance of `TransferClient`, then\nwe can use the API endpoints.\n\n```python\n>>> from transfer_client import TransferClient\n>>>\n>>> # Create a class instance for a server running on server_name.domain.\n>>> tc = TransferClient('server_name.domain')\n>>>\n>>> # Get user information together with its transfers.\n>>> tc.users('xxxxxxxx')\n{ ... }\n```", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://git.lumc.nl/apis/transfer_client", "keywords": "", "license": "MIT License", "maintainer": "", "maintainer_email": "", "name": "transfer-client", "package_url": "https://pypi.org/project/transfer-client/", "platform": "any", "project_url": "https://pypi.org/project/transfer-client/", "project_urls": { "Homepage": "https://git.lumc.nl/apis/transfer_client" }, "release_url": "https://pypi.org/project/transfer-client/0.4.0/", "requires_dist": null, "requires_python": "", "summary": "transfer-client: Transfer client library and CLI.", "version": "0.4.0" }, "last_serial": 3333092, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "77ce9b5b7b397640d1bb7f657ab6e4e3", "sha256": "6d28f3de39ca889c3cfe9340303327444f37af275918cdf702803a12a396ce91" }, "downloads": -1, "filename": "transfer-client-0.0.1.tar.gz", "has_sig": false, "md5_digest": "77ce9b5b7b397640d1bb7f657ab6e4e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5637, "upload_time": "2016-07-18T09:35:23", "url": "https://files.pythonhosted.org/packages/55/2f/3577578de04520982d62c94a30624fc45a5358520ca8556d8501838ceea8/transfer-client-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "e6eafdc4682bcf6f2f0f4a9d3f3ddecc", "sha256": "ad43b0a01b031a8965c99c10ccbbf2d9fce362c883ba1c34b404196d4d206536" }, "downloads": -1, "filename": "transfer-client-0.0.2.tar.gz", "has_sig": false, "md5_digest": "e6eafdc4682bcf6f2f0f4a9d3f3ddecc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5625, "upload_time": "2016-07-18T09:37:51", "url": "https://files.pythonhosted.org/packages/ec/32/bb9f5e17ceb7951bba218df1efd5822bc4cfd62bec1ca739be414e556415/transfer-client-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "560c107e6e51f0f294fa811c7a652167", "sha256": "8a26eb4322c331fb34a4eec7bff3865b45c0da55a69e8ac4583b46505cafdf3e" }, "downloads": -1, "filename": "transfer-client-0.0.3.tar.gz", "has_sig": false, "md5_digest": "560c107e6e51f0f294fa811c7a652167", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5622, "upload_time": "2016-08-08T11:51:38", "url": "https://files.pythonhosted.org/packages/60/a0/eff9b4e30252b8ba7247af905088eebfe6ad48b1ce14063861410d864412/transfer-client-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "ca4cbffaa3c0dfb456f6114aa1e5e96e", "sha256": "5871f71de06c19108c9f4ee702c0a2a670f202536c61291b66143d8b4c05003a" }, "downloads": -1, "filename": "transfer-client-0.0.4.tar.gz", "has_sig": false, "md5_digest": "ca4cbffaa3c0dfb456f6114aa1e5e96e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6231, "upload_time": "2016-11-03T08:45:38", "url": "https://files.pythonhosted.org/packages/5b/af/063ef9ae093af74a7c86f88ef924422914b73397a06a4261c47730a5a15b/transfer-client-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "59e670ff7140689efc56a7d801f89c33", "sha256": "7978d1822d2336992dba38c9f89620f3205643a59c1b9d95243e2bd7e44f26a2" }, "downloads": -1, "filename": "transfer-client-0.0.5.tar.gz", "has_sig": false, "md5_digest": "59e670ff7140689efc56a7d801f89c33", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6240, "upload_time": "2016-11-03T08:47:49", "url": "https://files.pythonhosted.org/packages/0f/94/6fdd5e3e3b6c9528ee4abf7e2c09f0105e181a0f82fe7d3644941151b202/transfer-client-0.0.5.tar.gz" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "a3e60aa158c2ba9ca74b00915f026a61", "sha256": "5efbf7e9a589303a2f8e98f45ebd309099e286f597b077bc228e328e08f94a0e" }, "downloads": -1, "filename": "transfer-client-0.0.6.tar.gz", "has_sig": false, "md5_digest": "a3e60aa158c2ba9ca74b00915f026a61", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8081, "upload_time": "2016-12-08T12:16:56", "url": "https://files.pythonhosted.org/packages/f4/b9/d06295e01d5be7842e221b161802e77c99047eb425ec7d8820d332ea270b/transfer-client-0.0.6.tar.gz" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "1f645d837fb60150af8e22da5f29a1e9", "sha256": "12001af064529ce00c5da09b3837c8192d99b3f1de98c743ce139cc638b73894" }, "downloads": -1, "filename": "transfer-client-0.0.7.tar.gz", "has_sig": false, "md5_digest": "1f645d837fb60150af8e22da5f29a1e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8433, "upload_time": "2017-05-04T07:27:31", "url": "https://files.pythonhosted.org/packages/40/b2/39aa1d585a28942cb6773bee786d51501f8484d0ee02ad748ee76c59f3db/transfer-client-0.0.7.tar.gz" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "c9f3ecfdd19ccc67221eb45bae3bc993", "sha256": "b08bce268a5e6b4284263a8b0acc5f9f7af3ba7c092d4229d5eaa65190892ba6" }, "downloads": -1, "filename": "transfer-client-0.0.8.tar.gz", "has_sig": false, "md5_digest": "c9f3ecfdd19ccc67221eb45bae3bc993", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8898, "upload_time": "2017-06-06T19:40:58", "url": "https://files.pythonhosted.org/packages/a8/3a/24c75b98720edb8d9ce526e71a19880f5c6234e37af30813a249540408ec/transfer-client-0.0.8.tar.gz" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "d411a9372a3997542dcac43b66755ce4", "sha256": "1bcf9df0558be0051002de584e1ad3de63b4e4e5fcb19ac6050624fe11718802" }, "downloads": -1, "filename": "transfer-client-0.0.9.tar.gz", "has_sig": false, "md5_digest": "d411a9372a3997542dcac43b66755ce4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9430, "upload_time": "2017-06-22T14:33:29", "url": "https://files.pythonhosted.org/packages/7d/a0/13f9fae05af326a5b32804c068cc964df8204f76b661e994efbabe50c051/transfer-client-0.0.9.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "43b9a02e7801dc29c8d7ff0861cc730a", "sha256": "6dc3a14b49cf841cecc21ddcbb676c5c8c3e40cc18b5ff1af97de1198cff5832" }, "downloads": -1, "filename": "transfer-client-0.1.1.tar.gz", "has_sig": false, "md5_digest": "43b9a02e7801dc29c8d7ff0861cc730a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11876, "upload_time": "2017-11-09T12:51:29", "url": "https://files.pythonhosted.org/packages/93/ce/1a586fbd068a86050e4b73672b3ed0392576461d892e15d9698b90c20b5c/transfer-client-0.1.1.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "d75e78839ba0bf893dca62c825ac765a", "sha256": "77828d1c52b486abad1be877e84a7aabdda0e544295a65d7810b89f5c214fedb" }, "downloads": -1, "filename": "transfer-client-0.2.0.tar.gz", "has_sig": false, "md5_digest": "d75e78839ba0bf893dca62c825ac765a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11896, "upload_time": "2017-11-09T14:42:30", "url": "https://files.pythonhosted.org/packages/67/ed/fb4355686c55222854c22988a860695d4326efc356fee82d464e8f20458c/transfer-client-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "08f162e0cbaf71abf9b3052e92e25071", "sha256": "0b6bc549c03e59bf84e6a352b2f66555cf621fb061933b9a6e1ba8bc0c8ced37" }, "downloads": -1, "filename": "transfer-client-0.3.0.tar.gz", "has_sig": false, "md5_digest": "08f162e0cbaf71abf9b3052e92e25071", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11869, "upload_time": "2017-11-09T19:00:07", "url": "https://files.pythonhosted.org/packages/85/84/c82d284f83981d0018c6149f1fb406d8ed837ef1274c1dff15599c286ccb/transfer-client-0.3.0.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "62e8b1650602804ccfec6f2c95ceda21", "sha256": "feb6b49e66fb9d7fab1772b76db0ea56fc3a504364812b8e03ed39c8b7244c56" }, "downloads": -1, "filename": "transfer-client-0.4.0.tar.gz", "has_sig": false, "md5_digest": "62e8b1650602804ccfec6f2c95ceda21", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12171, "upload_time": "2017-11-14T22:02:58", "url": "https://files.pythonhosted.org/packages/4c/02/47e82c0b2ba6ded762cc48d8b899a9a4c68247a66f632594c3a8af1a77a0/transfer-client-0.4.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "62e8b1650602804ccfec6f2c95ceda21", "sha256": "feb6b49e66fb9d7fab1772b76db0ea56fc3a504364812b8e03ed39c8b7244c56" }, "downloads": -1, "filename": "transfer-client-0.4.0.tar.gz", "has_sig": false, "md5_digest": "62e8b1650602804ccfec6f2c95ceda21", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12171, "upload_time": "2017-11-14T22:02:58", "url": "https://files.pythonhosted.org/packages/4c/02/47e82c0b2ba6ded762cc48d8b899a9a4c68247a66f632594c3a8af1a77a0/transfer-client-0.4.0.tar.gz" } ] }