Metadata-Version: 2.4
Name: djangocms_dag_jetcode
Version: 1.3.1
Summary: Django CMS DAG Jetcode is a plugin for Django CMS that allows you to add DAG System's Jetcodes on your site.
License: BSD-3-Clause
License-File: LICENSE
Author: Kapt dev team
Author-email: dev@kapt.mobi
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: Django (>=2.2,<3.0)
Requires-Dist: django-cms (==3.*)
Requires-Dist: django-multiselectfield (>=0.1.12,<0.2.0)
Requires-Dist: djangocms-attributes-field (>=2.0.0,<3.0.0)
Project-URL: Repository, https://gitlab.com/kapt/open-source/djangocms-dag-jetcode
Description-Content-Type: text/markdown

# djangocms-dag-jetcode

**Django CMS DAG Jetcode** is a plugin for [Django CMS](http://django-cms.org/) that allows you to add [DAG System](https://dag-system.com/)'s Jetcodes on your site.

![preview djangocms-dag-jetcode](https://gitlab.com/kapt/open-source/djangocms-dag-jetcode/-/raw/main/preview.png)

# Requirements

- Python 3.8+
- Django 2.0+
- Django CMS 3.8.0+

# Installation

- run `pip install djangocms-dag-jetcode`
- add `djangocms_dag_jetcode` to your `INSTALLED_APPS`
- include in your `urls.py`
  ```py
  path(
      "djangocms-dag-jetcode/",
      include("djangocms_dag_jetcode.urls", namespace="djangocms-dag-jetcode"),
  ),
  ```
- run `python manage.py migrate djangocms_dag_jetcode`
- import DAG's scripts before the closing `</body>` tag
  ```html
  <script src="https://jetcode.dag-system.com/jetcodes/fr?customerID=<your customer id>" defer></script>
  ```
- add required `<div>` for the basket
  ```html
  <div class="basket-jetcode" data-basket-id="0" css-jetcode-href="https://absolute.path/to/custom.css"></div>
  ```
- add required `<div>` for the popups
  ```html
  <div class="rate-jetcode-def" css-jetcode-href="https://absolute.path/to/custom.css"></div>
  <div class="cart-jetcode-def" css-jetcode-href="https://absolute.path/to/custom.css"></div>
  <div class="checkout-jetcode-def" css-jetcode-href="https://absolute.path/to/custom.css"></div>
  <div class="payinresult-jetcode-def" css-jetcode-href="https://absolute.path/to/custom.css"></div>
  <div class="shippinginfo-jetcode-def" css-jetcode-href="https://absolute.path/to/custom.css"></div>
  <div class="productinfo-jetcode-def" css-jetcode-href="https://absolute.path/to/custom.css"></div>
  ```

You can override some files to customize the style:
- `static/djangocms_dag_jetcode/css/base.css` base style for all Jetcodes
- `static/djangocms_dag_jetcode/css/product.css` product Jetcodes
- `static/djangocms_dag_jetcode/css/productselector.css` product selector Jetcodes
- `static/djangocms_dag_jetcode/css/package.css` package Jetcodes
- `static/djangocms_dag_jetcode/css/container.css` container Jetcodes
- `static/djangocms_dag_jetcode/img/calendar-icon.png` the calendar icon
- `templates/djangocms_dag_jetcode/default.html` the template used to render the Jetcodes

# Settings

## Styles choices

```python
DJANGOCMS_DAG_JETCODE_STYLE_CHOICES = [
  ("my-style", "My custom style"),
]
```
defaults to `[]`

Each style defined in this setting must have a corresponding CSS file in `{STATIC_ROOT}/djangocms_dag_jetcode/css/` (for example: `my-style.css`).

## Cache timeout

Set the cache timeout for the `get_css` view.
```python
DJANGOCMS_DAG_JETCODE_CACHE_TIMEOUT = 15 * 60
```
defaults to `15 * 60` (15 minutes)

When `DEBUG=True`, you can set this setting to `0` to disable the cache.

# Reload Jetcode after CMS plugin edit

When you add or edit a plugin, the CMS does not reload the entire page. You should re-instantiate the Jetcodes to display them without a page refresh. Add this code to your pages:
```js
if (window.hasOwnProperty('CMS') === true) {
  CMS.$(window).on('cms-content-refresh', function () {
    initJetcode()
  })
}
```

