===============
django CMS File
===============
|pypi| |build| |coverage| |python| |django| |djangocms|
**django CMS File** is a set of plugins for `django CMS <http://django-cms.org>`_
that allow you to add files to your site You can either choose a single file or
an entire folder.
It uses files managed by `Django Filer <https://github.com/divio/django-filer>`_.
This addon is compatible with `Divio Cloud <http://divio.com>`_
for easy installation.
.. image:: preview.gif
Contributing
============
This is a an open-source project. 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/divio/djangocms-file/graphs/contributors>`_
section.
One of the easiest contributions you can make is helping to translate this addon on
`Transifex <https://www.transifex.com/projects/p/djangocms-file/>`_.
Documentation
=============
See ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-file/blob/master/setup.py>`_
file for additional dependencies:
* Django Filer 1.7 or higher
Make sure `django-filer <http://django-filer.readthedocs.io/en/latest/installation.html>`_
is installed and configured appropriately.
Installation
------------
For a manual install:
* run ``pip install djangocms-file``
* add ``djangocms_file`` to your ``INSTALLED_APPS``
* run ``python manage.py migrate djangocms_file``
Configuration
-------------
Note that the provided templates are very minimal by design. You are encouraged
to adapt and override them to your project's requirements.
This addon provides a ``default`` template for all instances. You can provide
additional template choices by adding a ``DJANGOCMS_FILE_TEMPLATES``
setting::
DJANGOCMS_FILE_TEMPLATES = [
('feature', _('Featured Version')),
]
You'll need to create the ``feature`` folder inside ``templates/djangocms_file/``
otherwise you will get a *template does not exist* error. You can do this by
copying the ``default`` folder inside that directory and renaming it to
``feature``.
Running Tests
-------------
You can run tests by executing::
virtualenv env
source env/bin/activate
pip install -r test_requirements/base.txt
python setup.py test
.. |pypi| image:: https://badge.fury.io/py/djangocms-file.svg
:target: http://badge.fury.io/py/djangocms-file
.. |build| image:: https://travis-ci.org/django-cms/djangocms-file.svg?branch=master
:target: https://travis-ci.org/divio/djangocms-file
.. |coverage| image:: https://codecov.io/gh/django-cms/djangocms-file/branch/master/graph/badge.svg
:target: https://codecov.io/gh/divio/djangocms-file
.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg
:target: https://pypi.org/project/djangocms-file/
.. |django| image:: https://img.shields.io/badge/django-2.2--4.0-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/
Updating from `cmsplugin-filer <https://github.com/django-cms/cmsplugin-filer>`_
--------------------------------------------------------------------------------
Historically, `cmsplugin-filer` was used to create file, folder, image, link, teaser & video plugins on your django CMS projects. Now `cmsplugin-filer` has been archived, you can still migrate your old instances without having to copy them manually to the new `djangocms-<file|picture|link|...>` plugins.
There's a third-party management command that supports your migration:
`migrate_cmsplugin_filer.py <https://gist.github.com/corentinbettiol/84a6ea7e4d047fc01861b0af15fd60f0>`_
This management command is only a starting point. It *has* worked out of the box for some people, but we encourage you to read the code, understand what it does, and test it on a development environment before running it on your production server.
The management command is only configured to transfer your `cmsplugin_link`, `cmsplugin_file`, `cmsplugin_folder` and `cmsplugin_image` plugins to modern `djangocms_*` plugins. If you need to transfer other `cmsplugin_*` plugins, you'll have to write your own code.
Alternatively you can use the `deprecate_cmsplugin_filer <https://github.com/ImaginaryLandscape/deprecate_cmsplugin_filer>`_ app, which only adds a small migration that transfer the old `cmsplugin-filer` plugins instances to the new `djangocms-<file|picture|link|...>` plugins.
Raw data
{
"_id": null,
"home_page": "https://github.com/django-cms/djangocms-file",
"name": "djangocms-file",
"maintainer": "Django CMS Association and contributors",
"docs_url": null,
"requires_python": "",
"maintainer_email": "info@django-cms.org",
"keywords": "",
"author": "Divio AG",
"author_email": "info@divio.ch",
"download_url": "https://files.pythonhosted.org/packages/80/1a/1909347ae423e5481bfc4f6a3c0d4cb0c3b0ae9be069c60124cac4f4497b/djangocms-file-3.0.1.tar.gz",
"platform": null,
"description": "===============\ndjango CMS File\n===============\n\n|pypi| |build| |coverage| |python| |django| |djangocms|\n\n**django CMS File** is a set of plugins for `django CMS <http://django-cms.org>`_\nthat allow you to add files to your site You can either choose a single file or\nan entire folder.\n\nIt uses files managed by `Django Filer <https://github.com/divio/django-filer>`_.\n\nThis addon is compatible with `Divio Cloud <http://divio.com>`_\nfor easy installation.\n\n.. image:: preview.gif\n\n\nContributing\n============\n\nThis is a an open-source project. We'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/divio/djangocms-file/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/projects/p/djangocms-file/>`_.\n\n\nDocumentation\n=============\n\nSee ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-file/blob/master/setup.py>`_\nfile for additional dependencies:\n\n* Django Filer 1.7 or higher\n\nMake sure `django-filer <http://django-filer.readthedocs.io/en/latest/installation.html>`_\nis installed and configured appropriately.\n\n\nInstallation\n------------\n\nFor a manual install:\n\n* run ``pip install djangocms-file``\n* add ``djangocms_file`` to your ``INSTALLED_APPS``\n* run ``python manage.py migrate djangocms_file``\n\n\nConfiguration\n-------------\n\nNote that the provided templates are very minimal by design. You are encouraged\nto adapt and override them to your project's requirements.\n\nThis addon provides a ``default`` template for all instances. You can provide\nadditional template choices by adding a ``DJANGOCMS_FILE_TEMPLATES``\nsetting::\n\n DJANGOCMS_FILE_TEMPLATES = [\n ('feature', _('Featured Version')),\n ]\n\nYou'll need to create the ``feature`` folder inside ``templates/djangocms_file/``\notherwise you will get a *template does not exist* error. You can do this by\ncopying the ``default`` folder inside that directory and renaming it to\n``feature``.\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 test_requirements/base.txt\n python setup.py test\n\n\n.. |pypi| image:: https://badge.fury.io/py/djangocms-file.svg\n :target: http://badge.fury.io/py/djangocms-file\n.. |build| image:: https://travis-ci.org/django-cms/djangocms-file.svg?branch=master\n :target: https://travis-ci.org/divio/djangocms-file\n.. |coverage| image:: https://codecov.io/gh/django-cms/djangocms-file/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/divio/djangocms-file\n\n.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg\n :target: https://pypi.org/project/djangocms-file/\n.. |django| image:: https://img.shields.io/badge/django-2.2--4.0-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\n\nUpdating from `cmsplugin-filer <https://github.com/django-cms/cmsplugin-filer>`_\n--------------------------------------------------------------------------------\n\nHistorically, `cmsplugin-filer` was used to create file, folder, image, link, teaser & video plugins on your django CMS projects. Now `cmsplugin-filer` has been archived, you can still migrate your old instances without having to copy them manually to the new `djangocms-<file|picture|link|...>` plugins.\n\nThere's a third-party management command that supports your migration:\n\n`migrate_cmsplugin_filer.py <https://gist.github.com/corentinbettiol/84a6ea7e4d047fc01861b0af15fd60f0>`_\n\nThis management command is only a starting point. It *has* worked out of the box for some people, but we encourage you to read the code, understand what it does, and test it on a development environment before running it on your production server.\n\nThe management command is only configured to transfer your `cmsplugin_link`, `cmsplugin_file`, `cmsplugin_folder` and `cmsplugin_image` plugins to modern `djangocms_*` plugins. If you need to transfer other `cmsplugin_*` plugins, you'll have to write your own code.\n\nAlternatively you can use the `deprecate_cmsplugin_filer <https://github.com/ImaginaryLandscape/deprecate_cmsplugin_filer>`_ app, which only adds a small migration that transfer the old `cmsplugin-filer` plugins instances to the new `djangocms-<file|picture|link|...>` plugins.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Adds file plugin to django CMS",
"version": "3.0.1",
"project_urls": {
"Homepage": "https://github.com/django-cms/djangocms-file"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2eadc2a10b596ade3e871b9eac1a39f2ae17b6e4872e605ecd5e0ef819b6fdba",
"md5": "fb6b537a8333ab8e0aca5d04184c3ce2",
"sha256": "83a41fa18d5a0d032e79093de51503862dd6812bd63dfe6de06c5dd078108336"
},
"downloads": -1,
"filename": "djangocms_file-3.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb6b537a8333ab8e0aca5d04184c3ce2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 141827,
"upload_time": "2023-07-03T23:34:43",
"upload_time_iso_8601": "2023-07-03T23:34:43.799103Z",
"url": "https://files.pythonhosted.org/packages/2e/ad/c2a10b596ade3e871b9eac1a39f2ae17b6e4872e605ecd5e0ef819b6fdba/djangocms_file-3.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "801a1909347ae423e5481bfc4f6a3c0d4cb0c3b0ae9be069c60124cac4f4497b",
"md5": "2e4aaee7ec6656419a5147b445837982",
"sha256": "b4952eb57385fadb31f67ed61e34eec3fe5886669163f959d1b56a9ac0fb5b42"
},
"downloads": -1,
"filename": "djangocms-file-3.0.1.tar.gz",
"has_sig": false,
"md5_digest": "2e4aaee7ec6656419a5147b445837982",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31143,
"upload_time": "2023-07-03T23:34:45",
"upload_time_iso_8601": "2023-07-03T23:34:45.488931Z",
"url": "https://files.pythonhosted.org/packages/80/1a/1909347ae423e5481bfc4f6a3c0d4cb0c3b0ae9be069c60124cac4f4497b/djangocms-file-3.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-03 23:34:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django-cms",
"github_project": "djangocms-file",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "djangocms-file"
}
JSON
