Metadata-Version: 2.1
Name: modoboa-radicale
Version: 1.7.3
Summary: The Radicale frontend of Modoboa
Author-email: Antoine Nguyen <tonio@ngyn.org>
License: The MIT License (MIT)
        
        Copyright (c) 2015 Antoine Nguyen <tonio@ngyn.org>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
        
Project-URL: Homepage, https://modoboa.org/
Project-URL: Documentation, https://modoboa.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/modoboa/modoboa-radicale
Project-URL: Changelog, https://github.com/modoboa/modoboa-radicale/blob/master/CHANGELOG.md
Project-URL: Issues, https://github.com/modoboa/modoboa-radicale/issues
Keywords: modoboa,email,radicale,calendar,caldav
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django :: 4.2
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Communications :: Email
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: drf-nested-routers
Requires-Dist: django-webpack-loader==2.0.1
Requires-Dist: caldav==1.3.9
Provides-Extra: test
Requires-Dist: factory-boy<3.4.0; extra == "test"
Requires-Dist: testfixtures==8.1.0; extra == "test"
Requires-Dist: psycopg[binary]>=3.1; extra == "test"
Requires-Dist: mysqlclient<2.2.5; extra == "test"
Requires-Dist: packaging; extra == "test"

modoboa-radicale
================

|gha| |codecov|

The `Radicale <http://radicale.org/>`_ frontend of Modoboa.

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

Install this extension system-wide or inside a virtual environment by
running the following commands::

  $ pip install https://github.com/modoboa/caldav/tarball/master#egg=caldav
  $ pip install modoboa-radicale

Edit the settings.py file of your modoboa instance and apply the following modifications:

- add ``modoboa_radicale`` inside the ``MODOBOA_APPS`` variable like this::

    MODOBOA_APPS = (
      'modoboa',
      'modoboa.core',
      'modoboa.lib',
      'modoboa.admin',
      'modoboa.transport',
      'modoboa.relaydomains',
      'modoboa.limits',
      'modoboa.parameters',
      # Extensions here
      # ...
      'modoboa_radicale',
    )

- Add the following at the end of the file::

    from modoboa_radicale import settings as modoboa_radicale_settings
    modoboa_radicale_settings.apply(globals())

Run the following commands to setup the database tables::

  $ cd <modoboa_instance_dir>
  $ python manage.py migrate
  $ python manage.py load_initial_data
  $ python manage.py collectstatic
    
Finally, restart the python process running modoboa (uwsgi, gunicorn,
apache, whatever).

For developpers
---------------

The frontend part of this plugin is developed with `VueJS 2 <https://vuejs.org/>`_ and
requires `nodejs <https://nodejs.org/en/>`_ and `webpack <https://webpack.js.org/>`_.

Once nodejs is installed on your system, run the following commands::

  $ cd frontend
  $ npm install
  $ npm run serve

To update dist files (the ones that will be distributed with the plugin), run::

  $ npm run build

.. |gha| image:: https://github.com/modoboa/modoboa-radicale/actions/workflows/plugin.yml/badge.svg
   :target: https://github.com/modoboa/modoboa-radicale/actions/workflows/plugin.yml
.. |codecov| image:: http://codecov.io/github/modoboa/modoboa-radicale/coverage.svg?branch=master
   :target: http://codecov.io/github/modoboa/modoboa-radicale?branch=master
