Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyokenn/djradicale
CalDAV (calendar) and CardDAV (addressbook) Django Application based on Radicale
https://github.com/kyokenn/djradicale
Last synced: 24 days ago
JSON representation
CalDAV (calendar) and CardDAV (addressbook) Django Application based on Radicale
- Host: GitHub
- URL: https://github.com/kyokenn/djradicale
- Owner: kyokenn
- License: gpl-3.0
- Created: 2014-10-09T18:27:13.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-30T09:12:50.000Z (6 months ago)
- Last Synced: 2024-09-28T16:40:12.456Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 77.1 KB
- Stars: 54
- Watchers: 12
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - djradicale - CalDAV (calendar) and CardDAV (addressbook) Django Application based on Radicale (Python)
README
DjRadicale
==========
[Radicale](http://radicale.org/) is a free and open-source CalDAV and CardDAV server.
DjRadicale is an Django Application for integration Radicale with a Django.
Features
========
With all features that Radicale have you will also get:
* Django Models as a storage backend (it's possible to use any database supported by Django)
* Django Admin web interface for browsing/editing stored data
* Django Authentication as an authentication backend
* Django Settings as a Radicale config
Requirements
============
* Python >= 3.0
* Django >= 4.0.1
* Radicale >= 3.1.2, < 4.0.0
Installation
============
Install using PIP
-----------------
```
$ pip install djradicale
```
Configuration
=============
Modify your settings.py
-----------------------
```python
INSTALLED_APPS = (
...
'djradicale',
...
)
DJRADICALE_PREFIX = '/radicale/'
DJRADICALE_CONFIG = {
'auth': {
'type': 'djradicale.auth',
},
'rights': {
'type': 'djradicale.rights',
},
'storage': {
'type': 'djradicale.storage',
},
}
```
Modify you urls.py
------------------
```python
urlpatterns = [
...
path("" + settings.DJRADICALE_PREFIX.lstrip("/"),
include(("djradicale.urls", "djradicale-caldav"), namespace="djradicale")),
...
]
```
well-known urls configuration
=============================
You need to choose an implementation for handling of the "well-known" urls
External DjRadicale implementation
----------------------------------
Add this to your urls'py:
```python
from djradicale.views import WellKnownView
urlpatterns = [
...
path(".well-known/caldav",
WellKnownView.as_view(type="caldav"), name="well-known-caldav"),
path(".well-known/carddav",
WellKnownView.as_view(type="carddav"), name="well-known-carddav"),
...
]
```