PyAEM

PyAEM is a Python client for Adobe Experience Manager (AEM) API. The work was initially done by [Cliffano Subagio] (https://blog.cliffano.com/2014/05/21/wrapping-aem-curl-commands-with-python/) but the work stopped in 2014 and since then there hasn't been any update, but AEM has moved on.

I was in a project where I would like to convert some of my shell scripts to Python and found this from the Google search. This repo was a spin off from the original work and fixed to make it work for the Adobe's latest AEM Cloud.

Only Package Handling part of this tool has been fixed and tested with AEM as a Cloud on Python 3.9. Other parts will be done later ;-)

API Reference

Installation

pip install pyaem

Usage

import pyaem

aem = pyaem.PyAem('admin', 'password', 'localhost', 4502)

Content Management

aem.create_path('/content/mysite')

aem.activate_path('/content/mysite')

aem.does_user_exist('/home/users/m', 'myuser')

aem.create_user('/home/users/m', 'myuser', 'mypassword')

aem.add_user_to_group('myuser', '/home/groups/m', 'mygroup')

aem.does_group_exist('/home/groups/m', 'mygroup')

aem.create_group('/home/groups/m', 'mygroup')

aem.change_password('/home/users/m', 'myuser', 'myoldpassword', 'mynewpassword')

aem.set_permission('myuser')

aem.create_agent('myagent', 'flush', 'someuser', 'somepassword', 'http://somehost:8080', 'publish')

aem.delete_agent('myagent', 'publish')

aem.set_property('/content/mysite', 'sling:target', '/welcome.html')

Package Management

aem.create_package('mygroup', 'mypackage', 1.2.3)

aem.update_package('mygroup', 'mypackage', 1.2.3, acHandling = 'true')

aem.build_package('mygroup', 'mypackage', 1.2.3)

aem.download_package('mygroup', 'mypackage', 1.2.3, '/mnt/ephemeral0')

aem.upload_package('mygroup', 'mypackage', 1.2.3, '/mnt/ephemeral0', force = 'true')

aem.install_package('mygroup', 'mypackage', 1.2.3)

aem.replicate_package('mygroup', 'mypackage', 1.2.3)

aem.delete_package('mygroup', 'mypackage', 1.2.3)

aem.upload_package_sync('mygroup', 'mypackage', 1.2.3, '/mnt/ephemeral0', force = 'true')

aem.install_package_sync('mygroup', 'mypackage', 1.2.3)

aem.replicate_package_sync('mygroup', 'mypackage', 1.2.3)

Bundle Management

aem.start_bundle('mybundle')

aem.stop_bundle('mybundle')

aem.install_bundle('mybundle', 1.2.3, '/mnt/ephemeral0')

Workflow Management

aem.enable_workflow(
    '/etc/workflow/models/dam/update_asset/jcr:content/model',
    '/content/dam(/.*/)renditions/original',
    '/etc/workflow/launcher/config/update_asset_mod',
    'nt:file',
    'author')

aem.disable_workflow(
    '/etc/workflow/models/dam/update_asset/jcr:content/model',
    '/content/dam(/.*/)renditions/original',
    '/etc/workflow/launcher/config/update_asset_mod',
    'nt:file',
    'author')

Result And Error Handling

import pyaem

aem = pyaem.PyAem('admin', 'password', 'localhost', 4502)

try:

    result = aem.activate_path('/content/mysite')
    
    # check result status
    if result.is_success():
    	print 'Success: {0}'.format(result.message)
    else:
    	print 'Failure: {0}'.format(result.message)

    # debug response and request details via result
    print result.response['http_code']
    print result.response['body']
    print result.response['request']['method']
    print result.response['request']['url']
    print result.response['request']['params']

    # debug all response and request details in a single string
    print result.debug()

except pyaem.PyAemException, e:

    # exception message
    print e.message

    # exception code uses response http_code
    print e.code

    # debug response and request details via exception
    print e.response['http_code']
    print e.response['body']
    print e.response['request']['method']
    print e.response['request']['url']
    print e.response['request']['params']

Development

 apt-get install python-pip libcurl4-gnutls-dev python-dev
 make deps-dev
 make deps
 make build