pyaem2 package

Submodules

pyaem2.bagofrequests module

pyaem2.bagofrequests.download_file(url, params, handlers, **kwargs)

Downloads a file from specified URL, the file will be downloaded to path specified in file kwarg. Parameters will be appended to URL automatically on HTTP get method. Response code will then be used to determine which handler should process the response. When response code does not match any handler, an exception will be raised.

Parameters

• url (str) – URL to send HTTP request to

• params (dict) – Request parameters key-value pairs, use array value to represent multi parameters with the same name

• handlers (dict) – Response handlers key-value pairs, keys are response http code, values are callback methods

• kwargs (dict) – file (str) – Location where the downloaded file will be saved to

Returns

PyAem2Result – The result containing status, response http code and body, and request info

Raises

PyAem2Exception

pyaem2.bagofrequests.request(method, url, params, handlers, **kwargs)

Sends HTTP request to a specified URL. Parameters will be appended to URL automatically on HTTP get method. Response code will then be used to determine which handler should process the response. When response code does not match any handler, an exception will be raised.

Parameters

• method (str) – HTTP method (post, delete, get)

• url (str) – URL to send HTTP request to

• params (dict) – Request parameters key-value pairs, use array value to represent multi parameters with the same name

• handlers (dict) – Response handlers key-value pairs, keys are response http code, values are callback methods

Returns

PyAem2Result – Result of the request containing status, response http code and body, and request info

Raises

PyAem2Exception

pyaem2.bagofrequests.upload_file(url, params, handlers, **kwargs)

Uploads a file using the specified URL endpoint, the file to be uploaded must be available at the specified location in file kwarg. Parameters will be appended to URL automatically on HTTP get method. Response code will then be used to determine which handler should process the response. When response code does not match any handler, an exception will be raised.

Parameters

• url (str) – URL to send HTTP request to

• params (dict) – Request parameters key-value pairs, use array value to represent multi parameters with the same name

• handlers (dict) – Response handlers key-value pairs, keys are response http code, values are callback methods

• kwargs (dict) – file (str) – Location of the file to be uploaded

Returns

PyAem2Result – The result containing status, response http code and body, and request info

Raises

PyAem2Exception

pyaem2.contentrepo module

class pyaem2.contentrepo.ContentRepo(url, **kwargs)

Bases: object

activate_path(path, **kwargs)

add_user_to_group(user_name, group_path, group_name, **kwargs)

change_password(user_path, user_name, old_password, new_password, **kwargs)

create_agent(agent_name, agent_type, dest_username, dest_password, dest_url, run_mode, **kwargs)

create_group(group_path, group_name, **kwargs)

create_path(path, **kwargs)

create_user(user_path, user_name, password, **kwargs)

delete_agent(agent_name, run_mode, **kwargs)

delete_path(path, **kwargs)

disable_workflow(workflow, glob, edit, node_type, run_mode, **kwargs)

does_group_exist(group_path, group_name, **kwargs)

does_user_exist(user_path, user_name, **kwargs)

enable_workflow(workflow, glob, edit, node_type, run_mode, **kwargs)

get_cluster_list(**kwargs)

set_permission(user_or_group_name, path, permissions, **kwargs)

set_property(path, property_name, property_value, **kwargs)

pyaem2.exception module

exception pyaem2.exception.PyAem2Exception(code, message, response)

Bases: Exception

pyaem2.handlers module

pyaem2.handlers.auth_fail(response, **kwargs)

pyaem2.handlers.method_not_allowed(response, **kwargs)

pyaem2.handlers.unexpected(response, **kwargs)

pyaem2.packagemanager module

class pyaem2.packagemanager.PackageManager(url, **kwargs)

Bases: object

download_package(group_name, package_name, package_version, file_path, **kwargs)

update_package(group_name, package_name, package_version, **kwargs)

update_package_with_filter(group_name, package_name, package_version, filter_paths, **kwargs)

pyaem2.packagemanagerservicehtml module

class pyaem2.packagemanagerservicehtml.PackageManagerServiceHtml(url, **kwargs)

Bases: object

Package Manager service using /crx/packmgr/service/script.html AEM endpoint.

The endpoint’s response payload is in HTML format with message embedded in:

• <textarea>the message</textarea> fragment when status code is 200

• <div id=”message”>the message</div> fragment when status code is 201

The Adobe consultant I worked with advised me that this endpoint provides a ‘more synchronous’ operations compared to its /crx/packmgr/service/.json counterpart.

Check out PackageManager, PackageManagerServiceJson, and PackageManagerServiceJsp for other package-related services.

install_package(group_name, package_name, package_version, **kwargs)

replicate_package(group_name, package_name, package_version, **kwargs)

upload_package(group_name, package_name, package_version, file_path, **kwargs)

pyaem2.packagemanagerservicejson module

class pyaem2.packagemanagerservicejson.PackageManagerServiceJson(url, **kwargs)

Bases: object

build_package(group_name, package_name, package_version, **kwargs)

create_package(group_name, package_name, package_version, **kwargs)

delete_package(group_name, package_name, package_version, **kwargs)

install_package(group_name, package_name, package_version, **kwargs)

replicate_package(group_name, package_name, package_version, **kwargs)

upload_package(group_name, package_name, package_version, file_path, **kwargs)

pyaem2.packagemanagerservicejsp module

class pyaem2.packagemanagerservicejsp.PackageManagerServiceJsp(url, **kwargs)

Bases: object

is_package_installed(group_name, package_name, package_version, **kwargs)

is_package_uploaded(group_name, package_name, package_version, **kwargs)

pyaem2.pyaem2 module

class pyaem2.pyaem2.PyAem2(username, password, host, port, use_ssl=False, debug=False)

Bases: object

activate_path(path, **kwargs)

add_user_to_group(user_name, group_path, group_name, **kwargs)

build_package(group_name, package_name, package_version, **kwargs)

change_password(user_path, user_name, old_password, new_password, **kwargs)

create_agent(agent_name, agent_type, dest_username, dest_password, dest_url, run_mode, **kwargs)

create_group(group_path, group_name, **kwargs)

create_package(group_name, package_name, package_version, **kwargs)

create_path(path, **kwargs)

create_user(user_path, user_name, password, **kwargs)

delete_agent(agent_name, run_mode, **kwargs)

delete_package(group_name, package_name, package_version, **kwargs)

delete_path(path, **kwargs)

does_group_exist(group_path, group_name, **kwargs)

does_user_exist(user_path, user_name, **kwargs)

download_package(group_name, package_name, package_version, file_path, **kwargs)

install_bundle(bundle_name, bundle_version, file_path, **kwargs)

install_package(group_name, package_name, package_version, **kwargs)

install_package_sync(group_name, package_name, package_version, **kwargs)

is_package_installed(group_name, package_name, package_version, **kwargs)

is_package_uploaded(group_name, package_name, package_version, **kwargs)

is_valid_login(**kwargs)

replicate_package(group_name, package_name, package_version, **kwargs)

replicate_package_sync(group_name, package_name, package_version, **kwargs)

set_permission(user_or_group_name, path, permissions, **kwargs)

set_property(path, property_name, property_value, **kwargs)

start_bundle(bundle_name, **kwargs)

stop_bundle(bundle_name, **kwargs)

update_package(group_name, package_name, package_version, **kwargs)

update_package_with_filter(group_name, package_name, package_version, filter_paths, **kwargs)

upload_package(group_name, package_name, package_version, file_path, **kwargs)

upload_package_sync(group_name, package_name, package_version, file_path, **kwargs)

pyaem2.result module

class pyaem2.result.PyAem2Result(response)

Bases: object

debug()

failure(message)

is_failure()

is_success()

is_warning()

success(message)

warning(message)

pyaem2.sling module

class pyaem2.sling.Sling(url, **kwargs)

Bases: object

is_valid_login(**kwargs)

pyaem2.webconsole module

class pyaem2.webconsole.WebConsole(url, **kwargs)

Bases: object

install_bundle(bundle_name, bundle_version, file_path, **kwargs)

start_bundle(bundle_name, **kwargs)

stop_bundle(bundle_name, **kwargs)

Module contents