Skip to main content

XREA API wrapper

Project description

https://img.shields.io/pypi/v/xrea.svg https://img.shields.io/pypi/l/xrea.svg https://img.shields.io/pypi/pyversions/xrea.svg

This package is simple implementation of XREA API(https://apidoc.xrea.com) wrapper with Python 3.

“XREA” is the web hosting service in Japan.

Short description in Japanese

このPythonパッケージはXREA API(https://apidoc.xrea.com)のラッパーです。 Python3系(3.4以降)で使えます。

Supported services

Requirements

works with

  • Python 3.4+

  • requests

Installation

via pipenv

$ pipenv install xrea

via pip

$ pip install xrea

via setup.py

$ python setup.py install

Examples

Init:

>>> from xrea import Xrea # for CoreServer: from xrea import CoreServer
...
... account = "foo" # your account
... server_name = "z123456.xrea.com" # your server
... api_secret_key = "zajxTrzkHBGkRRfvWs5w397jZFqQKC8L" # your api_secret_key
>>> xrea = Xrea(account=account, server_name=server_name, api_secret_key=api_secret_key)

# for CoreServer
# xrea = CoreServer(account=account, server_name=server_name, api_secret_key=api_secret_key)

Call site/list without optional params:

>>> response = xrea.site.list()
>>> pprint(response.result)
{'1': {'domain': 'blank',
       'ip': '11.22.33.44,
       'no': 1,
       'nodir': 0,
       'phpver': 'php71',
       'redirect_url': '',
       'ssl_info': [],
       'ssl_status': 0},
 '2': {'domain': 'abcde.example.info',
       'ip': '11.22.33.44',
       'no': 2,
       'nodir': 0,
       'phpver': 'php71',
       'redirect_url': '',
       'ssl_info': [],
       'ssl_status': 1}}

Call log/log_list with optional params:

>>> response2 = xrea.log.log_list(type='analog')
>>> pprint(response2.result)
{'abcde.example.info': [{'filedate': '2018-01-14',
                         'filename': 'abcde.example.info.html'},
                        {'filedate': '2018-01-13',
                         'filename': 'abcde.example.info.1.html'}]}

Call aaa/bbb (not valid)

>>> response3 = xrea.aaa.bbb(foo='12345')
xrea.error.XreaApiResponseError: [status: 404, error: 100002]page_name:正しくありません

Author

NAKAMORI Ryosuke - https://github.com/tpdn

Licence

BSD-2-Clause

Project details


Download files

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

Source Distribution

xrea-0.1.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

xrea-0.1.1-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file xrea-0.1.1.tar.gz.

File metadata

  • Download URL: xrea-0.1.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for xrea-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ecf58cbdcd63c2e5009a4acc8e49856903472c00026da00e72c4c368af991d0a
MD5 e39f6a874cdb69c3716acad92026a765
BLAKE2b-256 fdc41b3c7929ec7654f4db2e46dea3c474160e9278f6cda300694d29804278ca

See more details on using hashes here.

File details

Details for the file xrea-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for xrea-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 abf09c3573b5c3f93dd17e1e93e9fb31a75d6588f8263efe105ca5ac7302090f
MD5 c7b6ebc6c686aa4e6681da591e298d9f
BLAKE2b-256 df6b7da3333db479d762d4a9f7ddc7f10344cd88fcb25d518eec28afa3e38fe5

See more details on using hashes here.

Supported by

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