semvec/pypi-packages huggingface dataset:
nuvla-api 4.2.3
Nuvla APIServer python client library
License: Apache-2.0
Requires Python: <4.0,>=3.9

# Nuvla Python Client Library

[![Build Status](https://github.com/nuvla/python-library/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/nuvla/python-library/actions/workflows/release.yml)

Nuvla client library to facilitate interaction with the Nuvla REST API
via the Python language.

## Artifacts

[![PyPi Project](https://img.shields.io/pypi/v/nuvla-api?label=nuvla-api)](https://pypi.org/project/nuvla-api)

Starting from **v3.0.0** this library is compatible only with Py3. If you are
still using Py2 (which is not recommended), then install `nuvla-api==2.1.2`.
v2.1.2 will not receive any updates.

## Documentation
You can get the full documentation by typing:

```python
from nuvla.api import Api
help(Api)
```

Or for a specific function:

```python
from nuvla.api import Api
help(Api.search)
```

## Usage

```python
  from nuvla.api import Api
  
  api = Api('https://nuvla.io')
  
  # Login with username & password
  api.login_password('username', 'password')
  # or
  # Login with api-key & secret
  api.login_apikey('credential/uuid', 'secret')

  api.search('user')

  # Logout
  api.logout()
  ```

## Copyright

Copyright &copy; 2019-2024, SixSq SA

## License

Licensed under the Apache License, Version 2.0 (the "License"); you
may not use this file except in compliance with the License.  You may
obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.  See the License for the specific language governing
permissions and limitations under the License.