Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dreipol/django-cookie-monster
This package gives you two versions of a cookie banner.
https://github.com/dreipol/django-cookie-monster
Last synced: 7 days ago
JSON representation
This package gives you two versions of a cookie banner.
- Host: GitHub
- URL: https://github.com/dreipol/django-cookie-monster
- Owner: dreipol
- License: other
- Created: 2019-10-16T11:16:58.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-15T15:10:16.000Z (over 1 year ago)
- Last Synced: 2023-05-15T16:24:50.437Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 884 KB
- Stars: 5
- Watchers: 11
- Forks: 0
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
# django-cookie-monster
[](https://circleci.com/gh/dreipol/django-cookie-monster)
[](https://codeclimate.com/github/dreipol/django-cookie-monster/maintainability)
[](https://coveralls.io/github/dreipol/django-cookie-monster?branch=develop)
This package gives you two versions of a cookie banner. The simple one is basically just a hint to inform users
that you are using cookies. The group version let's your users decide which cookies he needs.
Quickstart
----------
Install django-cookie-monster::
pip install django-cookie-monster
Add it to your `INSTALLED_APPS`:
```
INSTALLED_APPS = (
...
'cookie_monster',
...
)
```
Add a type and data property to all script tags that store any cookies.
```html
// This is my script
// This is my script
```
Settings
--------
Overwrite strings in your settings file. You will find a complete reference below.
```python
COOKIE_MONSTER = {
'banner': {
'title': 'My Cookie Banner Title',
}
}
```
To switch from standard to group mode you need to specify a list of setting groups.
```python
COOKIE_MONSTER = {
'cookie_groups': {
'rows': [
'Name',
'Provider',
'Purpose',
],
'groups': [
{
'title': 'Necessary',
'required': True,
'cookies': [
{
'id': 'application',
'rows': [
'Language',
'example.com',
'site language',
],
},
],
},
{
'title': 'Marketing',
'required': False,
'cookies': [
{
'id': 'GTM',
'rows': [
'Google Tag Manager',
'Google.com',
'tracking cookie',
],
},
],
},
],
},
}
```
This is an example of a fully customised version of a cookie banner:
```python
COOKIE_MONSTER = {
'banner': {
'title': 'My Cookie Banner Title',
'text': 'This is my custom text with a dynamic link to another page.',
'policy_link': 'contents.utils.my_callable_that_returns_a_dynamic_link_to_the_privacy_page',
'buttons': {
'confirm': {'label': 'Accept all cookies'},
'toggle': {'label': 'Toggle settings'},
'accept_all_cookies': {'label': 'Accept all Cookies'},
'accept_all_group_cookies': {'label': 'Accept {groupTitle} Cookies'}
},
},
'accordion_title': '{groupTitle} ({amount})',
'cookie': {
'samesite': 'Lax'
},
'custom_theme': True,
'cookie_groups': {
'rows': [
'Name',
'Provider',
'Purpose',
],
'groups': [
{
'title': 'Necessary',
'required': True,
'cookies': [
{
'id': 'application',
'rows': [
'Language',
'example.com',
'site language',
],
},
],
},
{
'title': 'Marketing',
'required': False,
'cookies': [
{
'id': 'GTM',
'rows': [
'Google Tag Manager',
'Google.com',
'tracking cookie',
],
},
],
},
],
},
}
```
# Contribute
## Installation
To install the frontend you will need to run:
```sh
npm i
```
## Building frontend
The frontend can be built via:
```sh
npm run build
```
## Unit test
You can unit test the frontend code with:
```sh
npm test
```