harbor/contrib/sdk/harbor-py/README.md

## Introduction

[harbor](https://github.com/vmware/harbor) is the enterprise-class registry server for docker distribution.

harbor-py is the native and compatible python SDK for harbor and is included in the harbor git repository under `contrib/sdk/harbor-py`.

The supported APIs are:

- [x] Projects APIs
  - [x] [Get projects](./examples/get_projects.py)
  - [x] [Create project](./examples/create_project.py)
  - [x] [Check project exist](./examples/check_project_exist.py)
  - [x] [Set project publicity](./examples/set_project_publicity.py)
  - [x] [Get project id from name](./examples/get_project_id_from_name.py)
  - [ ] Get project access logs
  - [ ] Get project member
  - [ ] Get project and user member
- [x] Users APIs
  - [x] [Get users](./examples/get_users.py)
  - [x] [Create user](./examples/create_user.py)
  - [x] [Update user profile](./examples/update_user_profile.py)
  - [x] [Delete user](./examples/delete_user.py)
  - [x] [Change password](./examples/change_password.py)
  - [x] [Promote as admin](./examples/promote_as_admin.py)
- [x] Repositories APIs
  - [x] [Get repositories](./examples/get_repositories.py)
  - [x] [Delete repository](./examples/delete_repository.py)
  - [x] [Get repository tags](./examples/get_repository_tags.py)
  - [x] [Get repository manifests](./examples/get_repository_manifests.py)
- [x] Others APIs
  - [x] [Search](./examples/search.py)
  - [x] [Get statistics](./examples/get_statistics.py)
  - [x] [Get top accessed repositories](./examples/get_top_accessed_repositories.py)
  - [x] [Get logs](./examples/get_logs.py)

## Installation

```
pip install harbor-py
```

## Usage

```
from harborclient import harborclient

host = "127.0.0.1"
user = "admin"
password = "Harbor12345"

client = harborclient.HarborClient(host, user, password)

client.get_projects()
client.get_users()
client.get_statistics()
client.get_top_accessed_repositories()
client.search("library")
```

For more usage, please refer to the [examples](./examples/).

## Contribution

If you have suggestions, feel free to submit [issues](https://github.com/vmware/harbor/issues) or send [pull-requests](https://github.com/vmware/harbor/pulls) for `harbor-py`.

Publish `harbor-py` package to [pypi](https://pypi.python.org/pypi/harbor-py/) server with the following commands.

```
python setup.py register -r pypi
python setup.py sdist upload  -r pypi
```