Merge pull request #20 from divio/feature/cleanup

Code cleanup and features

Author: FinalAngel

.coveragerc

@@ -0,0 +1,18 @@
+[run]
+branch = True
+source = djangocms_file
+omit =
+    migrations/*
+    tests/*
+
+[report]
+exclude_lines =
+    pragma: no cover
+    def __repr__
+    if self.debug:
+    if settings.DEBUG
+    raise AssertionError
+    raise NotImplementedError
+    if 0:
+    if __name__ == .__main__.:
+ignore_errors = True

.editorconfig

@@ -0,0 +1,31 @@
+# editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 80
+
+[*.py]
+max_line_length = 120
+quote_type = single
+
+[*.{scss,js,html}]
+max_line_length = 120
+indent_style = space
+quote_type = double
+
+[*.js]
+max_line_length = 120
+quote_type = single
+
+[*.rst]
+max_line_length = 80
+
+[*.yml]
+indent_size = 2

.gitignore

@@ -1,8 +1,8 @@
-*.log
-*.pot
 *.pyc
-local_settings.py
-djangocms_file.egg-info
-.tox
-build
-dist
+*.egg-info
+.DS_Store
+.idea/
+.tox/
+.eggs/
+dist/
+build/

.travis.yml

@@ -1,24 +1,27 @@
 language: python
 
-# Use container based infrastructure
 sudo: false
 
 env:
-  matrix:
-    - TOXENV=flake8
-
-cache:
-  directories:
-    - $HOME/.wheelhouse
+  - TOX_ENV=flake8
+  - TOX_ENV=py27-latest
+  - TOX_ENV=py34-latest
+  # Django 1.8
+  - TOX_ENV=py34-dj18-cms33
+  - TOX_ENV=py34-dj18-cms32
+  - TOX_ENV=py27-dj18-cms33
+  - TOX_ENV=py27-dj18-cms32
+  # Django 1.9
+  - TOX_ENV=py34-dj19-cms33
+  - TOX_ENV=py34-dj19-cms32
+  - TOX_ENV=py27-dj19-cms33
+  - TOX_ENV=py27-dj19-cms32
 
 install:
-  - pip install tox
-  - pip install coveralls
+  - pip install tox coverage
 
 script:
-  - tox -e $TOXENV
-
-after_success: coveralls
+  - tox -e $TOX_ENV
 
-notifications:
-  webhooks: http://addons.us-iad-rs.aldryn.io/en/travis-endpoint/
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

.tx/config

@@ -1,10 +1,8 @@
-
 [main]
 host = https://www.transifex.com
 
-[django-cms.djangocms-file]
+[djangocms-file.djangocms_file]
 file_filter = djangocms_file/locale/<lang>/LC_MESSAGES/django.po
 source_file = djangocms_file/locale/en/LC_MESSAGES/django.po
 source_lang = en
 type = PO
-

CHANGELOG.rst

@@ -0,0 +1,18 @@
+=========
+Changelog
+=========
+
+
+2.0.0 (unreleased)
+==================
+
+* Added tests
+* Cleaned up file structure
+* Removed Django < 1.8 support
+* Adapted ``README.txt``
+
+
+1.0.0 (2016-03-04)
+==================
+
+* Use this version for Django < 1.8 support

LICENSE.txt

@@ -8,17 +8,17 @@ modification, are permitted provided that the following conditions are met:
     * Redistributions in binary form must reproduce the above copyright
       notice, this list of conditions and the following disclaimer in the
       documentation and/or other materials provided with the distribution.
-    * Neither the name of Djeese Factory GmbH nor the
+    * Neither the name of Divio AG nor the
       names of its contributors may be used to endorse or promote products
       derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL DJEESE FACTORY GMBH BE LIABLE FOR ANY
+DISCLAIMED. IN NO EVENT SHALL DIVIO AG BE LIABLE FOR ANY
 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -2,4 +2,4 @@ include LICENSE.txt
 include README.rst
 recursive-include djangocms_file/locale *
 recursive-include djangocms_file/templates *
-recursive-exclude * *.py[co]
+recursive-exclude * *.pyc

README.rst

@@ -1,25 +1,92 @@
-djangocms-file
-==============
+===============
+django CMS File
+===============
 
-A file plugin for django CMS.
+
+|pypi| |build| |coverage|
+
+**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 `Aldryn <http://aldryn.com>`_ and is also available on the
+`django CMS Marketplace <https://marketplace.django-cms.org/en/addons/browse/djangocms-file/>`_
+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>`_.
+
+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:
+
+* Python 2.7, 3.3 or higher
+* Django 1.8 or higher
+
+Make sure `django Filer <http://django-filer.readthedocs.io/en/latest/installation.html>`_
+is installed and configured appropriately.
 
 
 Installation
 ------------
 
-This plugin requires `django CMS` 3.0 or higher to be properly installed.
+For a manual install:
 
-* In your projects `virtualenv`, run ``pip install djangocms-file``.
-* Add ``'djangocms_file'`` to your ``INSTALLED_APPS`` setting.
-* If using Django 1.6 and South < 1.0.2 add ``'djangocms_file': 'djangocms_file.south_migrations',``
-  to ``SOUTH_MIGRATION_MODULES``  (or define ``SOUTH_MIGRATION_MODULES`` if it
-  does not exists);
-* Run ``manage.py migrate djangocms_file``.
+* run ``pip install djangocms-file``
+* add ``djangocms_file`` to your ``INSTALLED_APPS``
+* run ``python manage.py migrate djangocms_file``
 
 
-Translations
-------------
+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 tests/requirements.txt
+    python setup.py test
 
-If you want to help translate the plugin please do it on transifex:
 
-https://www.transifex.com/projects/p/django-cms/resource/djangocms-file/
+.. |pypi| image:: https://badge.fury.io/py/djangocms-file.svg
+    :target: http://badge.fury.io/py/djangocms-file
+.. |build| image:: https://travis-ci.org/divio/djangocms-file.svg?branch=master
+    :target: https://travis-ci.org/divio/djangocms-file
+.. |coverage| image:: https://codecov.io/gh/divio/djangocms-file/branch/master/graph/badge.svg
+    :target: https://codecov.io/gh/divio/djangocms-file

addon.json

@@ -0,0 +1,6 @@
+{
+    "package-name": "djangocms-file",
+    "installed-apps": [
+        "djangocms_file"
+    ]
+}