Metadata-Version: 2.1
Name: odoo-addon-base_ical
Version: 18.0.1.0.0.3
Requires-Python: >=3.10
Requires-Dist: odoo==18.0.*
Requires-Dist: vobject
Summary: Provide (readonly) .ics URLs to calendar-like models
Home-page: https://github.com/OCA/server-backend
License: AGPL-3
Author: Hunki Enterprises BV, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Development Status :: 3 - Alpha
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

================================
Readonly publishing of calendars
================================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:5698ed5ec5d2491aa8522bb2cf642d06b3df464fa831d56acffed602f2ef108b
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
    :target: https://odoo-community.org/page/development-status
    :alt: Alpha
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--backend-lightgray.png?logo=github
    :target: https://github.com/OCA/server-backend/tree/18.0/base_ical
    :alt: OCA/server-backend
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
    :target: https://translation.odoo-community.org/projects/server-backend-18-0/server-backend-18-0-base_ical
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-backend&target_branch=18.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module allows administrators to configure iCalendars based on an
arbitrary selection on arbitrary models.

Users can selectively subscribe to them by enabling them in their
profile form.

This is useful for exposing Odoo data to calendaring application like
Nextcloud.

.. IMPORTANT::
   This is an alpha version, the data model and design can change at any time without warning.
   Only for development or testing purpose, do not use in production.
   `More details on development status <https://odoo-community.org/page/development-status>`_

**Table of contents**

.. contents::
   :local:

Configuration
=============

To configure this module, you need to:

1. Go to Settings/Technical/iCalendars
2. Create a iCalendar, fill in the model you want to expose and possibly
   a domain to restrict records. You can use the ``user`` variable to
   restrict things relative to the user using the iCalendar
3. A iCalendar is only available to the allowed users. Use the Allow
   automatically to make the iCalendar available to all users
4. See the examples below for a start

Examples
--------

Simple example, for model ``calendar.event``, you'd fill in
``record.allday and record.start_date or record.start`` as DTSTART and
``record.allday and record.stop_date or record.stop`` as DTEND.

Advanced example, for model ``calendar.event``, you'd use
``calendar = record._get_ics_file()`` in the code.

Advanced example, for model ``hr.leave``, you can use the following code
and ``[("employee_id.user_id", "=", user.id)]`` in the domain to export
the own time offs. This is a bit more complex because of the way Odoo
handles the begin and end times of leaves, and you'll want the extra day
as most clients interpret the end date as non-inclusive.:

.. code:: python

   confirmed = ("validate", "validate1")
   if record.request_unit_half or record.request_unit_hours:
      event = {
         "dtstart": event["dtstart"].date(),
         "dtend": event["dtend"].date() + timedelta(days=1),
      }
   else:
     event = {
         "dtstart": record.date_from,
         "dtend": record.date_to,
      }

   event["summary"] = record.name
   event["status"] = "CONFIRMED" if record.state in confirmed else "TENTATIVE"

Advanced example, for model ``mail.activity``, you can use the following
code and ``[("user_id", "=", user.id)]`` and domain to export all user
activities.

.. code:: python

   todo = {
      "summary": record.display_name,
      "due": record.date_deadline,
      "description": html2plaintext(record.note) if record.note else ""
   }

Usage
=====

To use this module, you need to:

1. Go to your profile form
2. Click Enable on one of the calendars listed in tab Calendars
3. Copy the URL to the application you use

Known issues / Roadmap
======================

- support all of
  https://datatracker.ietf.org/doc/html/rfc5545#section-3.8
- allow users to define their own calendars

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-backend/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-backend/issues/new?body=module:%20base_ical%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Hunki Enterprises BV

Contributors
------------

- Holger Brunn <mail@hunki-enterprises.com>
  (https://hunki-enterprises.com)
- Florian Kantelberg <florian.kantelberg@initos.com>
  (https://www.initos.com)

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

.. |maintainer-hbrunn| image:: https://github.com/hbrunn.png?size=40px
    :target: https://github.com/hbrunn
    :alt: hbrunn

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-hbrunn| 

This module is part of the `OCA/server-backend <https://github.com/OCA/server-backend/tree/18.0/base_ical>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
