From 61450cba56f53bd2fe4ae536e62e0e4e97bcb209 Mon Sep 17 00:00:00 2001 From: jreadey Date: Fri, 26 Apr 2024 08:32:04 -0700 Subject: [PATCH] move requirements.txt to .devcontainer --- .devcontainer/requirements.txt | 40 ++++++++++++++++++++++++++++++++++ .gitignore | 4 ++-- README.rst | 17 +++++++++------ 3 files changed, 52 insertions(+), 9 deletions(-) create mode 100644 .devcontainer/requirements.txt diff --git a/.devcontainer/requirements.txt b/.devcontainer/requirements.txt new file mode 100644 index 0000000..7d41991 --- /dev/null +++ b/.devcontainer/requirements.txt @@ -0,0 +1,40 @@ +aiobotocore==2.12.3 +aiohttp==3.9.5 +aioitertools==0.11.0 +aiosignal==1.3.1 +attrs==23.2.0 +botocore==1.34.69 +build==1.2.1 +certifi==2024.2.2 +charset-normalizer==3.3.2 +contourpy==1.2.1 +cycler==0.12.1 +flake8==7.0.0 +fonttools==4.51.0 +frozenlist==1.4.1 +fsspec==2024.3.1 +h5py==3.11.0 +h5pyd @ git+https://github.com/hdfgroup/h5pyd +idna==3.7 +jmespath==1.0.1 +kiwisolver==1.4.5 +matplotlib==3.8.4 +mccabe==0.7.0 +multidict==6.0.5 +numpy==1.26.4 +packaging==24.0 +pillow==10.3.0 +pycodestyle==2.11.1 +pyflakes==3.2.0 +PyJWT==2.8.0 +pyparsing==3.1.2 +pyproject_hooks==1.0.0 +python-dateutil==2.9.0.post0 +pytz==2024.1 +requests==2.31.0 +requests-unixsocket==0.3.0 +s3fs==2024.3.1 +six==1.16.0 +urllib3==2.2.1 +wrapt==1.16.0 +yarl==1.9.4 diff --git a/.gitignore b/.gitignore index c908539..03c3526 100644 --- a/.gitignore +++ b/.gitignore @@ -67,5 +67,5 @@ target/ # macOS stuff .DS_Store -# hsds config -/.hsds/ +# hsds data +data/ diff --git a/README.rst b/README.rst index c4b75ec..1d6554b 100644 --- a/README.rst +++ b/README.rst @@ -1,16 +1,18 @@ +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/hdfgroup/h5pyd) + h5pyd ===== .. image:: https://travis-ci.org/HDFGroup/h5pyd.svg?branch=master :target: https://travis-ci.org/HDFGroup/h5pyd -Python client library for HDF5 REST interface +Python client library for HSDS Introduction ------------ -This repository contains library, test, and examples of h5pyd - a Python package for the -HDF REST interface. +This repository contains library, test, and examples of h5pyd - a Python package for HSDS +(Highly Scalable Data Service), or other HDF REST compatible web services. The h5pyd library provides a high-level interface to the REST specification that is generally easier to use than invoking http calls directly. @@ -31,7 +33,6 @@ Related Projects ---------------- * HSDS: https://github.com/HDFGroup/hsds -* HDF Server: https://github.com/HDFGroup/h5serv * HDF5-JSON: https://github.com/HDFGroup/hdf5-json * h5py: https://github.com/h5py/h5py * REST API Documentation: https://github.com/HDFGroup/hdf-rest-api @@ -50,10 +51,12 @@ From a release tarball or Git checkout:: By default the examples look for a local instance of HSDS. See the https://github.com/HDFGroup/hsds for instructions on installing and running HSDS. -These tests are also to designed to work with HSDS (see https://github.com/HDFGroup/hsds). Install HSDS locally, or set environment variables (see next section) -to point to an existing HSDS instance. +These tests are also to designed to work with HSDS (see https://github.com/HDFGroup/hsds). +Install HSDS locally, or set environment variables (see next section) +to point to an existing HSDS instance. Alternatively, if you create as a Github codespace +(sell link above), HSDS will be automatically setup as part of the codespace. -h5pyd can all be run in serverless mode with either AWS Lambda or direct mode (storage system accessed directly). +Alternatively, h5pyd can all be run in serverless mode with either AWS Lambda or direct mode (storage system accessed directly). To use with AWS Lambda, set the HS_ENDPOINT to: "http+lambda://hslambda" where "hslambda" is the name of the lambda function. When using AWS Lambda some additional environment variables need to be set: