RESTClient

The cross-platform tool to work with http.

Installation

For most users, the recommended method to install is via pip:

pip install pyrestclient

or from source:

python setup.py install

Import

from pyrestclient import RESTClient

Changelog

UNRELEASED

1.1.9 (31.05.2023)

• auth_key attr added to customize auth response
• AuthToken removed. all it methods moved inside core class
• debug log extended

1.1.8 (13.09.2022)

Read timeout adjustment added. From now on you can set read and connection timeout simultaneously

• "auth_timeout" renamed to "connect_timeout" and value reduced to 5
• "read_timeout" global param added. Default value - 60.
• logger_enabled renamed to log_enabled
• logger_level renamed to log_level
• minor refactoring

1.1.7.post0 (8.07.2022)

• logger error fixed
• log level handler added

1.1.7 (8.07.2022)

• typo fixed
• requested_url() refactored
• encode_to_base64 logger added
• "[Response]" replaces with the "<-"

1.1.6 (3.06.2022)

• logger name is now RESTClient

1.1.5 (24.05.2022)

Breaking changes: REST assertion renamed and changed:

• return bool now
• is_success()
• is_ok()
• is_not_found()
• is_bad_request()
• is_unauthorized() new method

1.1.4 (23.05.2022)

• response logger added
• json_data() removed

1.1.3 (17.04.2022)

• updated to manage logger state

1.1.2 (29.03.2022)

• 'host' attr is '127.0.0.1' by default
• 'auth_timeout=7': new attr added
• '.encode_to_base64()': new method added
• plogger package added as dependency
• internal logger removed as unused

1.1.1 (15.02.2022)

wait_service_start fixed. added interval parameter

1.1.0 (8.02.2022)

• Fixed custom header usage

1.0.9.post0 (29.12.2021)

Fixed get token logger

1.0.9 (06.12.2021)

• token property changed to catch unavailability occasions (not verifying base URL availability)

1.0.8.post0 (31.08.2021)

• post without data fixed
• refactored custom header

1.0.8 (31.08.2021)

• logger added as attr

1.0.7 (21.05.2021)

• POST, PUT, DELETE extended with header=None param

1.0.6 (24.02.2021)

• refactoring. used lazy initialization to get token
• wait_service_start: for the is_service_initialized under the hood used 0.1 sec by default

1.0.5 (24.02.2021)

is_service_initialized updated to use timeout

1.0.4 (21.12.2020)

logger auth link fixed

1.0.3 (21.12.2020)

header param added to the GET method

1.0.2 (31.10.2020)

New base method added:

• is_host_available (Check remote host availability using socket and specified port)
• is_service_initialized (GET https://{IP}:{PORT})
• wait_service_start

1.0.1 (29.10.2020)

• PUT fixed
• RESTClient inherited from RESTAssertion. No need to import RESTAssertion directly

#####1.0.0 (14.10.2020)

• removed "extend_header"

#####0.1.0 (21.05.2020)

• file logging removed

#####0.0.9 (28.03.2020) DELETE fixed POST: added file support

#####0.0.8 (28.03.2020) header typing hint fixed. Now it is dict

#####0.0.7 (10.03.2020)

• Added query_params to all methods
• POST method was refactored to use .send_request()

#####0.0.6 (01.03.2020)

• removed full_url param. now it will automatically convert url. use "http[s]://site.com" format in methods to use full url.
• code refactoring

#####0.0.5 (01.03.2020)

• query params refactored to use urlencode
• added DELETE method

0.0.4 (27.02.2020)

should_be_bad_request: assert text fixed ...

0.0.1 (9.02.2020)

• initial commit