{ "info": { "author": "John Readey", "author_email": "jreadey@hdfgroup.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Software Development :: Build Tools" ], "description": "h5serv - REST-based service for HDF5 data\n===========================================\n\n.. image:: https://travis-ci.org/HDFGroup/h5serv.svg?branch=develop\n :target: https://travis-ci.org/HDFGroup/h5serv\n\nIntroduction\n------------\nh5serv is a web service that implements a REST-based web service for HDF5 data stores\nas described in the paper: http://hdfgroup.org/pubs/papers/RESTful_HDF5.pdf.\n\nWebsites\n--------\n\n* Main website: http://www.hdfgroup.org\n* Source code: https://github.com/HDFGroup/h5serv\n* Mailing list: hdf-forum@lists.hdfgroup.org \n* Documentation: http://h5serv.readthedocs.org\n\n\nQuick Install\n-------------\n\nInstall Python (2.7 or later) and the following packages:\n\n* NumPy 1.10.4 or later\n* h5py 2.5 or later\n* tornado 4.0.2 or later\n* watchdog 0.8.3 or later\n* requests 2.3 or later (for client tests)\n\nClone the hdf5-json project: ``git clone https://github.com/HDFGroup/hdf5-json.git`` .\nNext, cd to the hdf5-json folder and run: ``python setup.py install``.\n\nClone this project: ``git clone https://github.com/HDFGroup/h5serv.git``.\n\nRunning the Server\n------------------\n\nStart the server: ``cd h5serv/server; python app.py``.\n\nBy default the server will listen on port 5000. The port and and several other defaults can be modified\nwith command line options. For example to use port 8888 run: ``python app.py --port=8888``.\n\nSee test cases for examples of interacting with the server. Run: ``python testall.py`` from the test directory\nto run through the entire test suite.\n\nAlso, the interface (at least as far as read requests) can be explored in a browser. Go to: http://127.0.0.1:5000/.\nA JSON browser plugin will be helpful for formatting responses from the server to be more human readable.\n\nSee h5serv/docs/Installation.rst for step by step install instructions.\n\nRunning with Docker\n-------------------\n\nTo run h5serv as a docker container you just need to install Docker (no Python, h5py, etc. needed).\n\n* Install docker: https://docs.docker.com/installation/#installation.\n* Run the h5serv image: ``docker run -p 5000:5000 -d -v :/data hdfgroup/h5serv`` where is the folder path that contains any HDF5 files you want to made available through the h5serv REST API. Since requests to the server can modify (or delete!) content, you probably want to create a new folder and copy files to it.\n* Go to http://192.168.99.100:5000/ in your browser to verify the server is up and running (replace 192.168.99.100 with the IP address of the system or VM that is running the container).\n\nWriting Client Applications\n----------------------------\nAs a REST service, clients be developed using almost any programming language. The\ntest programs under: h5serv/test/integ illustrate some of the methods for peforming\ndifferent operations using Python.\n\nThe related project: https://github.com/HDFGroup/h5pyd provides a (mostly) h5py-compatible\ninterface to the server for Python clients.\n\n\nUninstalling\n------------\n\nh5serv does not modify anything in the system outside the directory where it was\ninstalled, so just remove the install directory and all contents to uninstall.\n\n\nReporting bugs (and general feedback)\n-------------------------------------\n\nCreate new issues at http://github.com/HDFGroup/h5serv/issues for any problems you find.\n\nFor general questions/feedback, please use the list (hdf-forum@lists.hdfgroup.org).", "description_content_type": null, "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/HDFGroup/h5serv", "keywords": "json hdf5 numpy array data", "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "h5serv", "package_url": "https://pypi.org/project/h5serv/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/h5serv/", "project_urls": { "Homepage": "https://github.com/HDFGroup/h5serv" }, "release_url": "https://pypi.org/project/h5serv/1.2.0/", "requires_dist": null, "requires_python": null, "summary": "HDF REST Server", "version": "1.2.0" }, "last_serial": 2477527, "releases": { "1.2.0": [] }, "urls": [] }