hoss-client 0.7.6
A client library and CLI for interacting with a Hoss server.
License: MIT
Requires Python: >=3.6
Keywords: data-science,science,gigantum,open-science,object-store,s3,minio


<p align="center">
    <img alt="Hoss" src="logo.svg" width="400" />
</p>

<h1 align="center">
  Python Client Library
</h1>


![pypi](https://img.shields.io/pypi/v/hoss-client)
![python versions](https://img.shields.io/pypi/pyversions/hoss-client?label=python)
[![Documentation Status](https://readthedocs.org/projects/hoss-client/badge/?version=stable)](https://hoss-client.readthedocs.io/en/stable/?badge=stable)


The Hoss client library provides Python bindings for interacting with a Hoss server and the data stored within it.

## Installing the Client Library from pypi
1. Create a virtualenv using Python 3.6 or later
2. Run `pip install -U hoss-client`

## Installing the Client Library from source
1. Create a virtualenv using Python 3.6 or later
2. Clone this repo
3. Run `pip3 install .` to install the `hoss-client` library

## Getting Started
Once you have access to a Hoss server, you must create a personal access token to interact with the API. 
Log in and navigate to the "personal access token" page using the drop down menu in the top
right corner. Then create a new personal access token.

Set the `HOSS_PAT` environmental variable to this token before using the client library (e.g. `export HOSS_PAT=hp_mytoken`).

The client library will automatically (via the `AuthService` class) handle getting a JWT as needed and check of the JWT has expired (and get a new JWT when that happens).

Then you can connect to the server and get started:

```
import hoss
import os
server = hoss.connect('https://hoss.my-domain.com')
```

## CLI Interface
The Hoss client library also provides a CLI when installed. Run `hoss -h` in your virtualenv to see available commands

The primary function currently provided by the CLI is an upload tool. This tool currently is optimized to upload a directory of medium to large files.
The the directory that you provide will be created in the specified dataset and all files that do not match the optional skip regex will be uploaded.
Files that already exist in the destination will not be uploaded again. Remember, you must set the `HOSS_PAT` env var before running the tool.

```
hoss upload <dataset name> <absolute path to the upload dir>
```

You can optionally write metadata key-value pairs using the -m flag (i.e -m subject_id=123). Multiple -m optional args are supported.

You can optionally filter out files to upload using a regex string with the --skip arg.

You can specify the endpoint (defaults to localhost) using the --endpoint arg.

## Examples
There are examples available in the `client/examples` directory. In particular, the `client/examples/notebooks` directory contains useful example Jupyter notebooks.


## Development

### Testing
This library is effectively tested via the Hoss [integration test suite](https://github.com/WyssCenter/hybrid-object-store/tree/main/test). These tests should be run or updated
as needed before accepting PRs.

### Docs
Docs are automatically built and published via GitHub actions to Read The Docs. 

To edit and view locally:
- Set up a virtualenv using the dependencies in `docs/requirements.txt`. 
- Install the `hoss-client` dependencies using something like `pip install .`
- Use Makefile to render your changes
    ```
    cd docs
    make html
    ```
- Then open `docs/build/html/index.html` in your browser.

### Release
To cut a new release, increment the library version in `hoss/version.py`. Then tag `main` using the same version. 
GitHub Actions will automatically update the "stable" docs and push a release to pypi.