kitconcept.contentcreator 1.0.6

Creator runner given a single file

Given a JSON file containing an array of objects to be created, this runner takes this array content (should have plone.restapi syntax compliant structure) and creates content out of it. You can load it using the method: load_json:

from kitconcept.contentcreator.creator import load_json

content_structure = load_json('testcontent/content.json', __file__)

Then you can call the runner with the method create_item_runner:

from kitconcept.contentcreator.creator import create_item_runner

create_item_runner(
    api.portal.get(),
    content_structure,
    default_lang='en',
    default_wf_state='published'
)

Creator runner given a folder with multiple files

Each file should contain a single p.restapi JSON compliant object (non arrayed, can’t contain other objects). It takes the placement in the tree hierarchy and the object id from the filename name (eg. de.beispiele.bildergroessen.json)

Setup runners from external modules/packages

Alternativelly, you can create custom content creators in other packages and call them all at the same time, via a custom adapter:

from kitconcept.contentcreator.interfaces import ICreateTestContent

for name, provider in getAdapters((api.portal.get(), ), ICreateTestContent):
  provider()

this should be the declaration in the other package:

@implementer(ICreateTestContent)
@adapter(IPloneSiteRoot)
class CreatePFGContent(object):
    """Adapter to create PFG initial content."""

    def __init__(self, context):
        self.context = context

    def __call__(self):
        content_structure = load_json('testcontent/content.json', __file__)

        create_item_runner(
            api.portal.get(),
            content_structure,
            default_lang='en',
            default_wf_state='published',
            ignore_wf_types=[
                'FormBooleanField',
                'FormDateField',
                'FormFileField',
                'FormFixedPointField',
                'FormIntegerField',
                'FormLabelField',
                'FormLinesField',
                'FormPasswordField',
            ],
        )

other common use is calling from a folder:

from kitconcept.contentcreator.creator import content_creator_from_folder

content_creator_from_folder(
    folder_name=os.path.join(os.path.dirname(__file__), "content_creator"),
    base_image_path=os.path.join(os.path.dirname(__file__), "images"),
    default_lang='en',
    default_wf_state='published',
    ignore_wf_types=[
        'FormBooleanField',
        'FormDateField',
        'FormFileField',
        'FormFixedPointField',
        'FormIntegerField',
        'FormLabelField',
        'FormLinesField',
        'FormPasswordField',
    ],
    logger=logger,
    temp_enable_content_types=[],
    custom_order=[
      'object-id-2.json',
      'object-id-3.json',
      'object-id-1.json',
    ],
)

Images

For the creation of images, you can use the plone.restapi approach using the following serialization mapping containg the file data and some additional metadata:

• data - the base64 encoded contents of the file

• encoding - the encoding you used to encode the data, so usually base64

• content-type - the MIME type of the file

• filename - the name of the file, including extension

{
  "...": "",
  "@type": "File",
  "title": "My file",
  "file": {
      "data": "TG9yZW0gSXBzdW0uCg==",
      "encoding": "base64",
      "filename": "lorem.txt",
      "content-type": "text/plain"}
}

Alternativelly, you can provide the image an extra property set_dummy_image with an array of (image) field names that will create a dummy image placeholder in the specified fields in the to be created content type:

{
  "id": "an-image",
  "@type": "Image",
  "title": "Test Image",
  "set_dummy_image": ["image"]
}

the deprecated form is also supported (it will create the image in the image field):

{
  "id": "an-image",
  "@type": "Image",
  "title": "Test Image",
  "set_dummy_image": true
}

You can specify a real image too, using a dict in the set_local_image JSON attribute with the field name and the filename of the real image:

{
  "id": "another-image",
  "@type": "Image",
  "title": "Another Test Image",
  "set_local_image": {"image": "image.png"}
}

the deprecated form is also supported (it will create the image in the image field):

{
  "id": "another-image",
  "@type": "Image",
  "title": "Another Test Image",
  "set_local_image": "image.png"
}

the same happen with files:

{
  "id": "an-file",
  "@type": "File",
  "title": "Test File",
  "set_dummy_file": ["file"]
}

the deprecated form is also supported (it will create the file in the file field):

{
  "id": "an-file",
  "@type": "File",
  "title": "Test File",
  "set_dummy_file": true
}

You can specify a real file too, using a dict in the set_local_file JSON attribute with the field name and the filename of the real file:

{
  "id": "another-file",
  "@type": "File",
  "title": "Another Test File",
  "set_local_file": {"file": "file.png"}
}

the deprecated form is also supported (it will create the file in the file field):

{
  "id": "another-file",
  "@type": "File",
  "title": "Another Test File",
  "set_local_file": "file.png"
}

You can specify the base_path for the image in the create_item_runner:

create_item_runner(
    api.portal.get(),
    content_structure,
    default_lang='en',
    default_wf_state='published',
    base_image_path=__file__
)

Development

Requirements:

• Python 3

• venv

Setup:

make

Run Static Code Analysis:

make code-Analysis

Run Unit / Integration Tests:

make test

Run Robot Framework based acceptance tests:

make test-acceptance

1.0.6 (2020-05-08)

• Publish package on pypi. [timo]

• Added the from a folder content creation. [sneridagh]

1.0.5 (2019-11-22)

• Improve error reporting in create_item_runner. [timo]

1.0.4 (2019-11-21)

• Re-release. [timo]

1.0.3 (2019-05-06)

• Re-release. [sneridagh]

1.0.2 (2019-05-06)

• Nothing changed yet.

1.0.1 (unreleased)

• Port to Python 3. [sneridagh]

• Documentation. [sneridagh]

1.0.0 (2019-03-26)

• Initial release. [kitconcept]