k2hr3client for python

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for hiwakaba from gravatar.com hiwakaba

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers
Report project as malware

Project description

https://img.shields.io/badge/license-MIT-blue.svg https://img.shields.io/pypi/pyversions/k2hr3client.svg https://img.shields.io/github/forks/yahoojapan/k2hr3client_python.svg https://img.shields.io/github/stars/yahoojapan/k2hr3client_python.svg https://img.shields.io/github/issues/yahoojapan/k2hr3client_python.svg https://github.com/yahoojapan/k2hr3client_python/workflows/Python%20package/badge.svg https://readthedocs.org/projects/k2hr3client-python/badge/?version=latest https://img.shields.io/pypi/v/k2hr3client

Overview

k2hr3client_python is an official Python WebAPI client for k2hr3.

https://k2hr3.antpick.ax/images/top_k2hr3.png

Install

Let’s install k2hr3client_python using pip:

pip install k2hr3client

Usage

Let’s try to get a token and create a resource.:

>>> from k2hr3client.token import K2hr3Token
>>> iaas_user = "demo"
>>> iaas_project = "demo"
>>> iaas_token_url = "http://172.24.4.1/identity/v3/auth/tokens"
>>> iaas_token = K2hr3Token.get_openstack_token(
...     iaas_token_url, iaas_user, "password", iaas_project
... )
>>> mytoken = K2hr3Token(iaas_project, iaas_token)
>>>
>>> from k2hr3client.http import K2hr3Http
>>> k2hr3_token_url = "http://127.0.0.1:18080"
>>> myhttp = K2hr3Http(k2hr3_token_url)
>>> myhttp.POST(mytoken.create())
>>> mytoken.token  # k2hr3 token
>>>
>>> from k2hr3client.resource import K2hr3Resource
>>> k2hr3_resource_name = "test_resource"
>>> myresource = K2hr3Resource(mytoken.token)
>>> myhttp.POST(
... myresource.create_conf_resource(
...     name=k2hr3_resource_name,
...     data_type="string",
...     data="testresourcedata",
...     keys={
...         "cluster-name": "test-cluster",
...         "chmpx-server-port": "8020",
...         "chmpx-server-ctrlport": "8021",
...         "chmpx-slave-ctrlport": "8031"},
...     alias=[])
... )
>>> myresource.resp.body # {"result":true...

Settings

To customize the settings of this library, place the configuration file in one of the following locations.:

$PWD/k2hr3client.ini
$HOME/.k2hr3client.ini
/etc/antpickax/k2hr3client.ini

To use the settings in your program, see the following example.:

>>> from k2hr3client import CONFIG
>>> print(CONFIG['DEFAULT']['iaas_user'])
demo

Here are the default settings.

section

key name

description

default value

DEFAULT

debug

Enable debug log if True

False

DEFAULT

iaas_url

IaaS API URL(OpenStack)

http://172.24.4.1

DEFAULT

iaas_project

IaaS project name

demo

DEFAULT

iaas_user

IaaS user name

demo

DEFAULT

iaas_password

IaaS password of the user

password

DEFAULT

log_file

log file name

sys.stderr

DEFAULT

log_dir

log directory name

logs

DEFAULT

log_level

log level(error,warn,info,debug,notset)

info

k2hr3

api_url

k2hr3 API URL

http://127.0.0.1:18080

k2hr3

api_version

k2hr3 api version

v1

http

timeout_seconds

timeout to establish tcp connections

30

http

retry_interval_seconds

interval to reconnect with HTTP server

60

http

max_retries

maximum count to reconnect with HTTP server

3

http

allow_self_signed_cert

Allow to use self-signed certification in HTTPS

False

Development

Clone this repository and go into the directory, then run the following command:

$ make init
$ pipenv shell
$ make lint test docs build

Documents

Here are documents including other components.

Document top page

About K2HR3

About AntPickax

Packages

Here are packages including other components.

k2hr3client(python packages)

License

MIT License. See the LICENSE file.

AntPickax

k2hr3client_python is a project by AntPickax, which is an open source team in LY Corporation.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for hiwakaba from gravatar.com hiwakaba

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Release history Release notifications | RSS feed

This version

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

k2hr3client-1.1.3.tar.gz (128.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

k2hr3client-1.1.3-py3-none-any.whl (44.2 kB view details)

Uploaded Python 3

File details

Details for the file k2hr3client-1.1.3.tar.gz.

File metadata

  • Download URL: k2hr3client-1.1.3.tar.gz
  • Upload date:
  • Size: 128.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for k2hr3client-1.1.3.tar.gz
Algorithm Hash digest
SHA256 1a13702ceff66690ee6fe23e89a1abe9bc720f15dbaa1fece8798b8912124a96
MD5 dda96b94de8b8d92840cd95696943e2a
BLAKE2b-256 2e2140594375d3c4986d63a95727e931e32a616bbe76c7f74b84e7837339f934

See more details on using hashes here.

Provenance

The following attestation bundles were made for k2hr3client-1.1.3.tar.gz:

Publisher: python-package.yml on yahoojapan/k2hr3client_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file k2hr3client-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: k2hr3client-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 44.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for k2hr3client-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cb610edab79205ab52dc770ede384af504e8ee52b233128cb1635465ac4b3e57
MD5 3ec17614f12ff791552935c1c61223bc
BLAKE2b-256 87e979ff090b2a6835b770df9018e02d708f6d034902df6132e4b41f4a7906db

See more details on using hashes here.

Provenance

The following attestation bundles were made for k2hr3client-1.1.3-py3-none-any.whl:

Publisher: python-package.yml on yahoojapan/k2hr3client_python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page