===================
django CMS Transfer
===================
|pypi| |build| |coverage|
**django CMS Transfer** is an **experimental** package that allows you to export
and import plugin data from a page or a placeholder. It does not support foreign
key relations and won't import/export related data, such as `media <https://github.com/django-cms/djangocms-transfer/issues/18>`_.
.. note::
This project is endorsed by the `django CMS Association <https://www.django-cms.org/en/about-us/>`_.
That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy.
Join us on `Slack <https://www.django-cms.org/slack/>`_.
.. image:: preview.gif
*******************************************
Contribute to this project and win rewards
*******************************************
Because this is a an open-source project, we welcome everyone to
`get involved in the project <https://www.django-cms.org/en/contribute/>`_ and
`receive a reward <https://www.django-cms.org/en/bounty-program/>`_ for their contribution.
Become part of a fantastic community and help us make django CMS the best CMS in the world.
We'll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your
pull request, please review our `contribution guidelines
<http://docs.django-cms.org/en/latest/contributing/index.html>`_.
We're grateful to all contributors who have helped create and maintain this package.
Contributors are listed at the `contributors <https://github.com/django-cms/djangocms-transfer/graphs/contributors>`_
section.
Documentation
=============
The setting ``DJANGO_CMS_TRANSFER_SERIALIZER`` allows to register a custom json serializer. An example for an use case could be to subclass Django's build-in python serializer and let it base64-encode inline image data base64.
See ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-transfer/blob/master/setup.py>`_
file for additional dependencies:
|python| |django| |djangocms|
Installation
------------
For a manual install:
* run ``pip install djangocms-transfer``
* add ``djangocms_transfer`` to your ``INSTALLED_APPS``
* run ``python manage.py migrate djangocms_transfer``
Customization
-------------
Following settings are available:
* **DJANGOCMS_TRANSFER_PROCESS_EXPORT_PLUGIN_DATA**:
Enables processing of plugin instances prior to serialization, e.g.
``myapp.module.function``.
* **DJANGOCMS_TRANSFER_PROCESS_IMPORT_PLUGIN_DATA**:
Enables processing of plugin instances prior to saving, e.g.
``myapp.module.function``.
For example: set default-values for ForeignKeys (images for django_filer, ..)
As an example the combination of ``_PROCESS_EXPORT_PLUGIN_DATA`` and
``_PROCESS_IMPORT_PLUGIN_DATA`` lets you export and import the data between
different systems while setting the contents as you need it::
# settings.py
.._PROCESS_EXPORT_PLUGIN_DATA = "myapp.some.module.export_function"
.._PROCESS_IMPORT_PLUGIN_DATA = "myapp.some.module.import_function"
# custom functions
def export_function(plugin, plugin_data):
# remove child-plugins which can't be handled
if plugin.parent_id and plugin.parent.plugin_type == "SomeParentPlugin":
return None
# change data
if plugin.plugin_type == "SomePlugin":
plugin_data["data"].update({
"some_field": "TODO: change me",
})
return plugin_data
def import_function(deserialized_object):
some_related_object = MyModel.objects.first()
for field in deserialized_object.object._meta.fields:
# example of setting a default value for a related field
if isinstance(field, ForeignKey):
value = getattr(deserialized_object.object, field.attname)
if field.related_model == MyModel and value is not None:
setattr(deserialized_object.object, field.name, some_related_object)
Running Tests
-------------
You can run tests by executing::
virtualenv env
source env/bin/activate
pip install -r tests/requirements/base.txt
python setup.py test
For code formatting, `black` is used. To automatically fix errors reported from
`black`, you can install it via virtualenv and
`pip install -r tests/requirements/base.txt`.
After this you just need to run `tools/black`.
.. |pypi| image:: https://badge.fury.io/py/djangocms-transfer.svg
:target: http://badge.fury.io/py/djangocms-transfer
.. |build| image:: https://travis-ci.org/divio/djangocms-transfer.svg?branch=master
:target: https://travis-ci.org/divio/djangocms-transfer
.. |coverage| image:: https://codecov.io/gh/divio/djangocms-transfer/branch/master/graph/badge.svg
:target: https://codecov.io/gh/divio/djangocms-transfer
.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg
:target: https://pypi.org/project/djangocms-transfer/
.. |django| image:: https://img.shields.io/badge/django-2.2,%203.0,%203.1-blue.svg
:target: https://www.djangoproject.com/
.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.7%2B-blue.svg
:target: https://www.django-cms.org/
Raw data
{
"_id": null,
"home_page": "https://github.com/django-cms/djangocms-transfer",
"name": "djangocms-transfer",
"maintainer": "Django CMS Association and contributors",
"docs_url": null,
"requires_python": null,
"maintainer_email": "info@django-cms.org",
"keywords": null,
"author": "Divio AG",
"author_email": "info@divio.ch",
"download_url": "https://files.pythonhosted.org/packages/ad/b2/9c4adda7a79b6dd38fe59990513f8200b2aa0ab97abe2f0a8caed7915b4b/djangocms_transfer-1.0.2.tar.gz",
"platform": null,
"description": "===================\ndjango CMS Transfer\n===================\n\n|pypi| |build| |coverage|\n\n**django CMS Transfer** is an **experimental** package that allows you to export\nand import plugin data from a page or a placeholder. It does not support foreign\nkey relations and won't import/export related data, such as `media <https://github.com/django-cms/djangocms-transfer/issues/18>`_.\n\n.. note:: \n \n This project is endorsed by the `django CMS Association <https://www.django-cms.org/en/about-us/>`_.\n That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy. \n Join us on `Slack <https://www.django-cms.org/slack/>`_.\n\n.. image:: preview.gif\n\n\n*******************************************\nContribute to this project and win rewards\n*******************************************\n\nBecause this is a an open-source project, we welcome everyone to\n`get involved in the project <https://www.django-cms.org/en/contribute/>`_ and\n`receive a reward <https://www.django-cms.org/en/bounty-program/>`_ for their contribution. \nBecome part of a fantastic community and help us make django CMS the best CMS in the world. \n\nWe'll be delighted to receive your\nfeedback in the form of issues and pull requests. Before submitting your\npull request, please review our `contribution guidelines\n<http://docs.django-cms.org/en/latest/contributing/index.html>`_.\n\nWe're grateful to all contributors who have helped create and maintain this package.\nContributors are listed at the `contributors <https://github.com/django-cms/djangocms-transfer/graphs/contributors>`_\nsection.\n\n\nDocumentation\n=============\n\nThe setting ``DJANGO_CMS_TRANSFER_SERIALIZER`` allows to register a custom json serializer. An example for an use case could be to subclass Django's build-in python serializer and let it base64-encode inline image data base64. \n\nSee ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-transfer/blob/master/setup.py>`_\nfile for additional dependencies:\n\n|python| |django| |djangocms|\n\n\nInstallation\n------------\n\nFor a manual install:\n\n* run ``pip install djangocms-transfer``\n* add ``djangocms_transfer`` to your ``INSTALLED_APPS``\n* run ``python manage.py migrate djangocms_transfer``\n\n\nCustomization\n-------------\n\nFollowing settings are available:\n\n* **DJANGOCMS_TRANSFER_PROCESS_EXPORT_PLUGIN_DATA**:\n\n Enables processing of plugin instances prior to serialization, e.g.\n ``myapp.module.function``.\n\n* **DJANGOCMS_TRANSFER_PROCESS_IMPORT_PLUGIN_DATA**:\n\n Enables processing of plugin instances prior to saving, e.g.\n ``myapp.module.function``.\n For example: set default-values for ForeignKeys (images for django_filer, ..)\n\nAs an example the combination of ``_PROCESS_EXPORT_PLUGIN_DATA`` and\n``_PROCESS_IMPORT_PLUGIN_DATA`` lets you export and import the data between\ndifferent systems while setting the contents as you need it::\n\n # settings.py\n .._PROCESS_EXPORT_PLUGIN_DATA = \"myapp.some.module.export_function\"\n .._PROCESS_IMPORT_PLUGIN_DATA = \"myapp.some.module.import_function\"\n\n # custom functions\n def export_function(plugin, plugin_data):\n # remove child-plugins which can't be handled\n if plugin.parent_id and plugin.parent.plugin_type == \"SomeParentPlugin\":\n return None\n # change data\n if plugin.plugin_type == \"SomePlugin\":\n plugin_data[\"data\"].update({\n \"some_field\": \"TODO: change me\",\n })\n return plugin_data\n\n def import_function(deserialized_object):\n some_related_object = MyModel.objects.first()\n for field in deserialized_object.object._meta.fields:\n # example of setting a default value for a related field\n if isinstance(field, ForeignKey):\n value = getattr(deserialized_object.object, field.attname)\n if field.related_model == MyModel and value is not None:\n setattr(deserialized_object.object, field.name, some_related_object)\n\n\nRunning Tests\n-------------\n\nYou can run tests by executing::\n\n virtualenv env\n source env/bin/activate\n pip install -r tests/requirements/base.txt\n python setup.py test\n\nFor code formatting, `black` is used. To automatically fix errors reported from\n`black`, you can install it via virtualenv and\n`pip install -r tests/requirements/base.txt`.\nAfter this you just need to run `tools/black`.\n\n\n.. |pypi| image:: https://badge.fury.io/py/djangocms-transfer.svg\n :target: http://badge.fury.io/py/djangocms-transfer\n.. |build| image:: https://travis-ci.org/divio/djangocms-transfer.svg?branch=master\n :target: https://travis-ci.org/divio/djangocms-transfer\n.. |coverage| image:: https://codecov.io/gh/divio/djangocms-transfer/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/divio/djangocms-transfer\n\n.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg\n :target: https://pypi.org/project/djangocms-transfer/\n.. |django| image:: https://img.shields.io/badge/django-2.2,%203.0,%203.1-blue.svg\n :target: https://www.djangoproject.com/\n.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.7%2B-blue.svg\n :target: https://www.django-cms.org/\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Adds import and export of plugin data.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/django-cms/djangocms-transfer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e1fd3e522400ff464409f10aa6bb1ef3023a31a025e92200de4e0e958d47d2d7",
"md5": "0a9500b87b4dedc5fb8e451c3566e36c",
"sha256": "49e3ef6d02729047c38d9e2f3a69b133003d65d582b1260e50ce603c5baeed6e"
},
"downloads": -1,
"filename": "djangocms_transfer-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a9500b87b4dedc5fb8e451c3566e36c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21162,
"upload_time": "2024-04-23T06:05:19",
"upload_time_iso_8601": "2024-04-23T06:05:19.535861Z",
"url": "https://files.pythonhosted.org/packages/e1/fd/3e522400ff464409f10aa6bb1ef3023a31a025e92200de4e0e958d47d2d7/djangocms_transfer-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "adb29c4adda7a79b6dd38fe59990513f8200b2aa0ab97abe2f0a8caed7915b4b",
"md5": "33b05e2a3362529fafe4894963726073",
"sha256": "ce0676cb884f08958488fda7e0be5e2db50922e4ff70ea98c792420857fc9a35"
},
"downloads": -1,
"filename": "djangocms_transfer-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "33b05e2a3362529fafe4894963726073",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18872,
"upload_time": "2024-04-23T06:05:21",
"upload_time_iso_8601": "2024-04-23T06:05:21.863397Z",
"url": "https://files.pythonhosted.org/packages/ad/b2/9c4adda7a79b6dd38fe59990513f8200b2aa0ab97abe2f0a8caed7915b4b/djangocms_transfer-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-23 06:05:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django-cms",
"github_project": "djangocms-transfer",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "djangocms-transfer"
}
JSON
