Gestion de contenu
Go to file
Frédéric Péters f7d517f789 settings: declare passerelle as a provider of statistics (#53856) 2021-07-02 07:55:45 +02:00
combo settings: declare passerelle as a provider of statistics (#53856) 2021-07-02 07:55:45 +02:00
debian debian: add --all-backends option to lingo-poll-backend (#53861) 2021-05-07 18:06:07 +02:00
tests wcs: custom title for cards cell (#54549) 2021-06-25 14:18:01 +02:00
.git-blame-ignore-revs misc: add isort reformat reference to git blame ignore list (#52797) 2021-04-08 16:53:53 +02:00
.gitignore gitignore: ignore generated css file 2019-12-21 16:07:32 +01:00
.pre-commit-config.yaml misc: add isort (#52797) 2021-04-08 15:54:31 +02:00
COPYING add license file 2014-12-07 15:01:15 +01:00
Jenkinsfile build: update to use origin/main 2020-12-26 15:21:15 +01:00
MANIFEST.in misc: add wcs-app js file to MANIFEST.in 2020-11-17 19:47:19 +01:00
README misc: remove sqlite support (#52912) 2021-06-03 10:24:23 +02:00
getlasso3.sh tox: load lasso (#35425) 2019-08-18 14:46:56 +02:00
manage.py debian: switch to Python 3 (#36233) 2019-10-13 15:41:19 +02:00
pylint.sh create jenkins pipeline job (#23431) 2018-06-01 10:16:24 +02:00
requirements.txt misc: remove django-jsonfield dependency (#52912) 2021-06-03 10:24:21 +02:00
setup.py misc: remove django-jsonfield dependency (#52912) 2021-06-03 10:24:21 +02:00
tox.ini tox: limit psycopg2 to < 2.9 (#54925) 2021-06-17 08:53:51 +02:00

README

Combo
=====

Combo is a simple content management system, tailored to create simple
websites, and with a specialization in aggregating contents from different
sources.

Installation
------------

Dependencies can be installed with pip,

 $ pip install -r requirements.txt

It's then required to get the database configured (./manage.py migrate); by
default it will create a postgresqsl DB.

You can then run the Django test server for a quick try (you should refer to
the Django documentation for production deployments).

 $ ./manage.py runserver


Architecture
------------

Combo manages content as a series of pages (objects of type 'Page'), that can
be sorted ('order' attribute) and hierarchically ordered ('parent' attribute).

Every pages have a title and a "slug", that is used as the page URL; a page
with 'index' as its slug will be served as the index page of the site.

The pages are set to use a template; the templates are defined in the settings
file (COMBO_PUBLIC_TEMPLATES) and are made of a name, a template file, and a
serie of "placeholders", identifying locations in the page (main content, side
bar, footer...).

Example:

    'standard': {
        'name': 'Standard',
        'template': 'combo/page_template.html',
        'placeholders': {
            'content': {
                'name': 'Content',
            },
            'footer': {
                'name': 'Footer',
                'acquired': True,
            },
        }
    }

The content of a page is defined as a serie of cells, of which there are
various types (they are all subclasses of CellBase); each cell is also
associated with a placeholder ('placeholder' attribute) and its order within
('order' attribute).

A placeholder can be marked as 'acquired' (see "footer" in the example above),
this way a cell of "same as parent" type will automatically be added.


Settings
--------

Default settings are loaded from settings.py, they can be overloaded by a
local_settings.py file set in the same directory, or by a file referenced
in the COMBO_SETTINGS_FILE environment variable.

SAML authentication can be enabled by adding 'mellon' to INSTALLED_APPS and
'mellon.backends.SAMLBackend' to AUTHENTICATION_BACKENDS, this requires
django-mellon to be installed, and further files and settings are required:

 - public and private keys (in cert.pem and key.cert in the current working
   directory, or from files defined in the MELLON_PUBLIC_KEYS and
   MELLON_PRIVATE_KEY settings)
 - metadata of the identity provider (in idp-metadata.xml, or defined using
   the MELLON_IDENTITY_PROVIDERS settings)

Details on these options and additional SAML settings are available in the
documentation of django-mellon.


Tests
-----

Unit tests are written using py.test, and its pytest-django support library.

  DJANGO_SETTINGS_MODULE=combo.settings COMBO_SETTINGS_FILE=tests/settings.py py.test


Code Style
----------

black is used to format the code, using thoses parameters:

    black --target-version py37 --skip-string-normalization --line-length 110

isort is used to format the imports, using those parameters:

    isort --profile black --line-length 110

There is .pre-commit-config.yaml to use pre-commit to automatically run black and isort
before commits. (execute `pre-commit install` to install the git hook.)


License
-------

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
details.

You should have received a copy of the GNU Affero General Public License along
with this program.  If not, see <http://www.gnu.org/licenses/>.


Combo embeds some other pieces of code, with their own authors and copyright
notices:

Gauge.js
  Files: combo/apps/dataviz/static/js/gauge.min.js
  License: MIT
  Comment:
   From http://bernii.github.io/gauge.js/

Pygal.tooltip.js
  Files: combo/apps/dataviz/static/js/pygal.tooltip.js
  Copyright: 2015, Florian Mounier Kozea
  License: LGPL-3+
  Comment:
   From https://github.com/Kozea/pygal.js/