|django| |djangocms4|
*********************
django CMS Versioning
*********************
.. warning::
This is the development branch for django CMS version 4.1 support.
For django CMS V4.0 support, see `support/django-cms-4.0.x branch <https://github.com/django-cms/djangocms-versioning/tree/support/django-cms-4.0.x>`_
============
Installation
============
Requirements
============
django CMS Versioning requires that you have a django CMS 4.0 (or higher) project already running and set up.
To install
==========
Run::
pip install djangocms-versioning
Add ``djangocms_versioning`` to your project's ``INSTALLED_APPS``.
Run::
python -m manage migrate djangocms_versioning
python -m manage create_versions --user-id <user-id-of-migration-user>
to perform the application's database migrations and (only if you have an existing database) add version objects
needed to mark existing versions as draft.
=====
Usage
=====
Versioning integration instructions are available in `docs/versioning_integration.rst <docs/versioning_integration.rst>`_
An example implementation can be found here:
- `djangocms_versioning/test_utils/polls/cms_config.py <djangocms_versioning/test_utils/polls/cms_config.py>`_
- `djangocms_versioning/test_utils/polls/models.py <djangocms_versioning/test_utils/polls/models.py>`_
Testing
=======
To run all the tests the only thing you need to do is run
pip install -r tests/requirements.txt
python setup.py test
Documentation
=============
We maintain documentation under the ``docs`` folder using rst format.
To generate the HTML documentation you will need to install ``sphinx`` (``pip install sphinx``) and ``graphviz`` (as per your operating system's package management system). You can then generate the docs using the following command:
Run::
cd docs/
make html
This should generate all html files from rst documents under `docs/_build` folder, which can be browsed.
============
Contributing
============
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>`_.
The project makes use of git pre-commit hooks to maintain code quality.
Please follow the installation steps to get `pre-commit <https://pre-commit.com/#installation>`_
setup in your development environment.
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-versioning/graphs/contributors>`_
section.
One of the easiest contributions you can make is helping to translate this addon on
`Transifex <https://www.transifex.com/divio/django-cms-versioning/dashboard/>`_.
To update transifex translation in this repo you need to download the
`transifex cli <https://developers.transifex.com/docs/cli>`_ and run
``tx pull`` from the repo's root directory. After downloading the translations
do not forget to run the ``compilemessages`` management command.
.. |django| image:: https://img.shields.io/badge/django-3.2%2B-blue.svg
:target: https://www.djangoproject.com/
.. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4.1-blue.svg
:target: https://www.django-cms.org/
Raw data
{
"_id": null,
"home_page": "http://github.com/django-cms/djangocms-versioning",
"name": "djangocms-versioning",
"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/45/6c/c90ae0b3448d18d410f8b164db0d35cc4c364395e2bbb0030df62f6c0af3/djangocms_versioning-2.1.0.tar.gz",
"platform": null,
"description": "|django| |djangocms4|\n\n*********************\ndjango CMS Versioning\n*********************\n\n.. warning::\n\n This is the development branch for django CMS version 4.1 support.\n\n For django CMS V4.0 support, see `support/django-cms-4.0.x branch <https://github.com/django-cms/djangocms-versioning/tree/support/django-cms-4.0.x>`_\n\n\n============\nInstallation\n============\n\nRequirements\n============\n\ndjango CMS Versioning requires that you have a django CMS 4.0 (or higher) project already running and set up.\n\n\nTo install\n==========\n\nRun::\n\n pip install djangocms-versioning\n\nAdd ``djangocms_versioning`` to your project's ``INSTALLED_APPS``.\n\nRun::\n\n python -m manage migrate djangocms_versioning\n python -m manage create_versions --user-id <user-id-of-migration-user> \n\nto perform the application's database migrations and (only if you have an existing database) add version objects\nneeded to mark existing versions as draft.\n\n\n=====\nUsage\n=====\n\nVersioning integration instructions are available in `docs/versioning_integration.rst <docs/versioning_integration.rst>`_\n\nAn example implementation can be found here:\n\n- `djangocms_versioning/test_utils/polls/cms_config.py <djangocms_versioning/test_utils/polls/cms_config.py>`_\n- `djangocms_versioning/test_utils/polls/models.py <djangocms_versioning/test_utils/polls/models.py>`_\n\n\nTesting\n=======\n\nTo run all the tests the only thing you need to do is run\n\n pip install -r tests/requirements.txt\n python setup.py test\n\n\nDocumentation\n=============\n\nWe maintain documentation under the ``docs`` folder using rst format.\n\nTo generate the HTML documentation you will need to install ``sphinx`` (``pip install sphinx``) and ``graphviz`` (as per your operating system's package management system). You can then generate the docs using the following command:\n\nRun::\n\n cd docs/\n make html\n\nThis should generate all html files from rst documents under `docs/_build` folder, which can be browsed.\n\n============\nContributing\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\nThe project makes use of git pre-commit hooks to maintain code quality.\nPlease follow the installation steps to get `pre-commit <https://pre-commit.com/#installation>`_\nsetup in your development environment.\n\nWe're grateful to all contributors who have helped create and maintain\nthis package. Contributors are listed at the `contributors\n<https://github.com/django-cms/djangocms-versioning/graphs/contributors>`_\nsection.\n\nOne of the easiest contributions you can make is helping to translate this addon on\n`Transifex <https://www.transifex.com/divio/django-cms-versioning/dashboard/>`_.\nTo update transifex translation in this repo you need to download the\n`transifex cli <https://developers.transifex.com/docs/cli>`_ and run\n``tx pull`` from the repo's root directory. After downloading the translations\ndo not forget to run the ``compilemessages`` management command.\n\n\n.. |django| image:: https://img.shields.io/badge/django-3.2%2B-blue.svg\n :target: https://www.djangoproject.com/\n.. |djangocms4| image:: https://img.shields.io/badge/django%20CMS-4.1-blue.svg\n :target: https://www.django-cms.org/\n",
"bugtrack_url": null,
"license": "BSD",
"summary": null,
"version": "2.1.0",
"project_urls": {
"Homepage": "http://github.com/django-cms/djangocms-versioning"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1889821ff42cc85bc55ec0173336ce4495797d2558c595756996e0be1d287c74",
"md5": "857407399b99c747d93cc4bd14497391",
"sha256": "f7197609632bbc6b7372a14db92a860a2bc827eb2185101d59228a0a25a70623"
},
"downloads": -1,
"filename": "djangocms_versioning-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "857407399b99c747d93cc4bd14497391",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 681392,
"upload_time": "2024-10-28T21:11:09",
"upload_time_iso_8601": "2024-10-28T21:11:09.535863Z",
"url": "https://files.pythonhosted.org/packages/18/89/821ff42cc85bc55ec0173336ce4495797d2558c595756996e0be1d287c74/djangocms_versioning-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "456cc90ae0b3448d18d410f8b164db0d35cc4c364395e2bbb0030df62f6c0af3",
"md5": "41da2421ed85037fe1dd36d97ec98745",
"sha256": "9fd21d9152864023156aa8d19c68cd2745667276daef2fcfbf1fe7b28e7d8ebb"
},
"downloads": -1,
"filename": "djangocms_versioning-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "41da2421ed85037fe1dd36d97ec98745",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 595609,
"upload_time": "2024-10-28T21:11:10",
"upload_time_iso_8601": "2024-10-28T21:11:10.792000Z",
"url": "https://files.pythonhosted.org/packages/45/6c/c90ae0b3448d18d410f8b164db0d35cc4c364395e2bbb0030df62f6c0af3/djangocms_versioning-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 21:11:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django-cms",
"github_project": "djangocms-versioning",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "djangocms-versioning"
}
JSON
