{ "info": { "author": "Anthony M. Castronova", "author_email": "acastronova@cuahsi.org", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Scientific/Engineering :: Hydrology" ], "description": "# HSTools\n\nA humble collection of HydroShare tools written in Python 3. The `hstools` library was originally a port of the CUAHSI JupyterHub `utilities.hydroshare` package modified to work on desktop computers. The goal is to provide a set of basic functions that simplify working with HydroShare data.\n\n## Libaray Installation\n\n```\ngit clone https://github.com/Castronova/hstools.git\ncd hstools\npython setup.py install\n```\n\n## Getting Started\n\nAfter the libary is installed, it can be executed using the following command: `hs`. There are currently 6 options for interacting with HydroShare: `get`, `add`, `create`, `delete`, `ls`, and `init`. For detailed information about any of these add the `--help` flag after the options, e.g. `$hs get --help`.\n\n```\n$ hs\nusage: hs [-h] {get,add,create,delete,ls,init} ...\n\nHSTools is a humble collection of tools for interacting with data in the\nHydroShare repository. It wraps the HydroShare REST API to provide simple\ncommands for working with resources.\n\npositional arguments:\n {get,add,create,delete,ls,init}\n get Retrieve resource content from HydroShare\n add Add files to an existing HydroShare resource\n create Create a new HydroShare resource\n delete Delete a HydroShare resource\n list List HydroShare resources that you own\n init Initialize a connection with HydroShare\n\noptional arguments:\n -h, --help show this help message and exit\n```\n\n\n## Initialize a Connection to HydroShare\n\nConnect to HydroShare using the `init` option. This will create an authentication file for accessing HydroShare that is cached in your `$HOME` directory by default. This path can be changed using the `-d` flag. Note, this command only needs to be executed once.\n\n\n```\n$ hs init\nEnter HydroShare Username: \nEnter HydroShare Password: \nAuth saved to: ~/.hs_auth\n```\n\n## Create a HydroShare Resource\n\nCreate a new HydroShare resource using the `create` options.\n\n\n```\n$ hs create \\\n-a This is the abstract of my resource \\\n-t My resource Title \\\n-k keyword1 keyword2 keyword3 \\\n-f myfile.txt ./another/file.txt \n```\n\n\n## List HydroShare Resources\n\nListing HydroShare resources using the `ls` options.\n\n\n```\n$ hs list\n```\n\nList files in long format\n\n```\n$ hs list -l\n```\n\nList the first 17 resources in long format\n\n```\n$ hs list -l -n 17\n```\n\nFilter resources by published\n\n```\n$ hs list -filter published=true\n```\n\n## Download a HydroShare Resource\n\nDownloading data from the HydroShare platform is done using globally unique identfiers (GUID). This GUIDs are defined for every HydroShare resource and can be aquired from a resources URL. The `get` option downloads the resource bagit archive and unzips it into a directory of your choosing.\n\n\n```\n$ hs get \n```\n\n## Add Files to a HydroShare Resource\n\nAdd files to an existing HydroShare resource using the `add` option. This command allows you to optionally overwrite (`--overwrite`) files that already exist in a resource, which is helpful when updating content.\n\n\n```\n$ hs add -f my-file.txt my-other-file.txt\n```\n\n\n## Deleting a HydroShare Resource\n\nDelete an entire HydroShare resource using the `delete` option. This is useful for cleaning up your HydroShare workspace. BEWARE: THIS WILL PERMANENTLY DELETE YOUR HYDROSHARE RESOURCE DATA.\n\n```\n$ hs delete \n```\n\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/castronova/hstools", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "HSTools", "package_url": "https://pypi.org/project/HSTools/", "platform": "", "project_url": "https://pypi.org/project/HSTools/", "project_urls": { "Homepage": "https://github.com/castronova/hstools" }, "release_url": "https://pypi.org/project/HSTools/0.0.3/", "requires_dist": [ "certifi (>=2019.9.11)", "chardet (<4,>=3.0.4)", "hs-restclient (<2,>=1.3)", "idna (<3,>=2.8)", "oauthlib (<4,>=3)", "requests (<3,>=2.22.0)", "requests-oauthlib (<2,>=1.2.0)", "requests-toolbelt (<0.10,>=0.9.1)", "urllib3 (<1.25.9,>=1.25.4)", "PyYAML (<6,>=5.3)" ], "requires_python": ">=3.6", "summary": "A humble collection of HydroShare tools written in Python", "version": "0.0.3", "yanked": false, "yanked_reason": null }, "last_serial": 8013737, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "855a21e99ad3de3f214e2db66f79c45d", "sha256": "bfb5be21617b415fe6592b3c1a3635340d6975b90ff2a8c5ee2e42e508850905" }, "downloads": -1, "filename": "HSTools-0.0.1-py3.7.egg", "has_sig": false, "md5_digest": "855a21e99ad3de3f214e2db66f79c45d", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": ">=3.6", "size": 61718, "upload_time": "2019-10-30T19:43:52", "upload_time_iso_8601": "2019-10-30T19:43:52.709242Z", "url": "https://files.pythonhosted.org/packages/b8/5f/28e2a0501ba8d8f68b88d32fd0b03f6ec4d198f52a30c3fa99d5918f0f25/HSTools-0.0.1-py3.7.egg", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "7c7bd6872d7fecd3079385736a91fb50", "sha256": "7276b14bcfd1a1f014ef5967fdf9b0ef90d6b71f5ca2b2db3302c0e0f88c6892" }, "downloads": -1, "filename": "HSTools-0.0.1-py3.8.egg", "has_sig": false, "md5_digest": "7c7bd6872d7fecd3079385736a91fb50", "packagetype": "bdist_egg", "python_version": "3.8", "requires_python": ">=3.6", "size": 65925, "upload_time": "2020-06-08T18:12:47", "upload_time_iso_8601": "2020-06-08T18:12:47.091043Z", "url": "https://files.pythonhosted.org/packages/0d/df/c68d19c46294a8dde023dacc2f7114eba50009fa08f4d244179dbe73bf8c/HSTools-0.0.1-py3.8.egg", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "ef0180a8541c6e8adf371dd605b1dc45", "sha256": "e967a55504552b9c6b132582c500185e7d220c65d6ea0fdff57c555729078c5a" }, "downloads": -1, "filename": "HSTools-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "ef0180a8541c6e8adf371dd605b1dc45", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 46663, "upload_time": "2019-10-30T19:43:50", "upload_time_iso_8601": "2019-10-30T19:43:50.395578Z", "url": "https://files.pythonhosted.org/packages/41/1b/322c44c5c63d204be8a66ed00ef2f7b0fb46a502df8d41417754bb282db2/HSTools-0.0.1-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "c870feb1aead31349ee54676822d9333", "sha256": "6f20628fc4efeb9c9e2cb5496489dbb6ee57df76edfc79af4119de395434e916" }, "downloads": -1, "filename": "HSTools-0.0.1.tar.gz", "has_sig": false, "md5_digest": "c870feb1aead31349ee54676822d9333", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 14889, "upload_time": "2019-10-30T19:43:54", "upload_time_iso_8601": "2019-10-30T19:43:54.142135Z", "url": "https://files.pythonhosted.org/packages/b4/87/edd539b7b8a703325073d663d54172f085aaa2ddca94b2258d37fdd01ecb/HSTools-0.0.1.tar.gz", "yanked": false, "yanked_reason": null } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "dfdb254080b94faa12db10bd9dc622bb", "sha256": "36309ccb57bf08abf24e92e89f9c48723e394385361a596cafed50ae8a94e419" }, "downloads": -1, "filename": "HSTools-0.0.2-py3.7.egg", "has_sig": false, "md5_digest": "dfdb254080b94faa12db10bd9dc622bb", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": ">=3.6", "size": 75858, "upload_time": "2020-08-21T17:02:50", "upload_time_iso_8601": "2020-08-21T17:02:50.004380Z", "url": "https://files.pythonhosted.org/packages/7c/e7/651f65cbf3ad411c1446562b3c99d1f0e2899c0ae1b3c976c81edb07b895/HSTools-0.0.2-py3.7.egg", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "ee6f690429e8b9347f074df08ff2abcb", "sha256": "2d4bad563c9aba5cbb7755af37e7895d027e6cb839d770f06b4a682f59ef56eb" }, "downloads": -1, "filename": "HSTools-0.0.2-py3.8.egg", "has_sig": false, "md5_digest": "ee6f690429e8b9347f074df08ff2abcb", "packagetype": "bdist_egg", "python_version": "3.8", "requires_python": ">=3.6", "size": 65076, "upload_time": "2020-06-08T19:18:14", "upload_time_iso_8601": "2020-06-08T19:18:14.523919Z", "url": "https://files.pythonhosted.org/packages/ee/9d/0a3679b8fb06913dd90c408fc58a900a5d7ef5f644481ef977277b4829f8/HSTools-0.0.2-py3.8.egg", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "f9218799074866b37c428202188d13f9", "sha256": "b695b3a0f1a1f07baf60b2cd39311720b006e4ba85575217c1c5f9f32a4e71d2" }, "downloads": -1, "filename": "HSTools-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "f9218799074866b37c428202188d13f9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 41662, "upload_time": "2020-06-08T19:34:44", "upload_time_iso_8601": "2020-06-08T19:34:44.689808Z", "url": "https://files.pythonhosted.org/packages/51/6a/9e874b83b43c6069580902ded33cc98aad820f3f40977d1fc287470905fa/HSTools-0.0.2-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "acbdb64c578c95ee2755327d66ce5bde", "sha256": "10b01d60de71795a444c6963f2c5bc06830df24f5720d0e07852f7110f9d3388" }, "downloads": -1, "filename": "HSTools-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "acbdb64c578c95ee2755327d66ce5bde", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 41710, "upload_time": "2020-08-21T17:02:48", "upload_time_iso_8601": "2020-08-21T17:02:48.630101Z", "url": "https://files.pythonhosted.org/packages/08/e9/95b3d94ec23f518ef88adb0723e6ff1c0d4e0aa8083de309a5dd93e8fc6c/HSTools-0.0.3-py3-none-any.whl", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "acbdb64c578c95ee2755327d66ce5bde", "sha256": "10b01d60de71795a444c6963f2c5bc06830df24f5720d0e07852f7110f9d3388" }, "downloads": -1, "filename": "HSTools-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "acbdb64c578c95ee2755327d66ce5bde", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 41710, "upload_time": "2020-08-21T17:02:48", "upload_time_iso_8601": "2020-08-21T17:02:48.630101Z", "url": "https://files.pythonhosted.org/packages/08/e9/95b3d94ec23f518ef88adb0723e6ff1c0d4e0aa8083de309a5dd93e8fc6c/HSTools-0.0.3-py3-none-any.whl", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }