https://github.com/aem-design/pyaem2

Python client for Adobe Experience Manager (AEM) API
https://github.com/aem-design/pyaem2

aem devops python

Last synced: about 2 months ago
JSON representation

Python client for Adobe Experience Manager (AEM) API

• Host: GitHub
• URL: https://github.com/aem-design/pyaem2
• Owner: aem-design
• License: apache-2.0
• Created: 2015-01-19T09:17:44.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-09-20T00:39:26.000Z (over 5 years ago)
• Last Synced: 2024-10-01T16:08:37.356Z (3 months ago)
• Topics: aem, devops, python
• Language: Python
• Homepage: http://aem-design.github.io/pyaem2/
• Size: 5.78 MB
• Stars: 18
• Watchers: 18
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PyAEM 2

[![Build Status](https://travis-ci.org/aem-design/pyaem2.svg?branch=master)](https://travis-ci.org/aem-design/pyaem2)

[![Coverage Status](https://coveralls.io/repos/github/aem-design/pyaem2/badge.svg)](https://coveralls.io/github/aem-design/pyaem2)

[![codecov](https://codecov.io/gh/aem-design/pyaem2/branch/master/graph/badge.svg)](https://codecov.io/gh/aem-design/pyaem2)

[![PyPI](https://img.shields.io/pypi/v/pyaem2)](https://pypi.org/project/pyaem2/)

[![github license](https://img.shields.io/github/license/aem-design/pyaem2)](https://github.com/aem-design/pyaem2) 

[![github issues](https://img.shields.io/github/issues/aem-design/pyaem2)](https://github.com/aem-design/pyaem2) 

[![github last commit](https://img.shields.io/github/last-commit/aem-design/pyaem2)](https://github.com/aem-design/pyaem2) 

[![github repo size](https://img.shields.io/github/repo-size/aem-design/pyaem2)](https://github.com/aem-design/pyaem2) 

PyAEM 2.0 is a Python client for [Adobe Experience Manager](http://dev.day.com/docs/en/cq/current.html) (AEM) API.

Tested with AEM 5.6.1, 6.2 SP1 and AEM 6.3+ on Python 2.7 and 3.6

## Installation

    pip install pyaem2

## Usage

    import pyaem2

    aem = pyaem2.PyAem2('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.update_package_with_filter('mygroup', 'mypackage', 1.2.3, '/content/dam', 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)

Package Management

    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')

## Result And Error Handling

    import pyaem2

    aem = pyaem2.PyAem2('admin', 'password', 'localhost', 4502)

    try:

        result = aem.activate_path('/content/mysite')

        result = aem.create_package('mygroup', 'pyaem2-create-package', '1.2.3')

        result = aem.update_package_with_filter('mygroup', 'pyaem2-create-package', '1.2.3', '/content/dam')

        # 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 pyaem2.PyAem2Exception, 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

Dev

```bash

  apt-get install python-pip libcurl4-gnutls-dev python-dev

  make deps-dev

  make deps

  make build

```

Test

```bash

  make test

```