An open API service indexing awesome lists of open source software.

https://github.com/mback2k/django-webgcal

WebGCal web application - Django project
https://github.com/mback2k/django-webgcal

Last synced: 10 months ago
JSON representation

WebGCal web application - Django project

Awesome Lists containing this project

README

          

WebGCal
=======

Dependencies
------------
- Django [https://www.djangoproject.com/]
- Celery [http://www.celeryproject.org/]
- SwampDragon [http://swampdragon.net/]
- pytz [http://pytz.sourceforge.net/]
- Google API [https://code.google.com/p/google-api-python-client/]
- django-celery-beat [https://github.com/celery/django-celery-beat]
- django-celery-results [https://github.com/celery/django-celery-results]
- django-celery-model [https://github.com/mback2k/django-celery-model]
- django_compressor [https://github.com/jezdez/django_compressor]
- python-social-auth [https://github.com/omab/python-social-auth]
- python-appengine-auth [https://github.com/mback2k/python-appengine-auth]
- python-hcalendar [https://github.com/mback2k/python-hcalendar]

Submodules
----------
- django-jdatetime [https://github.com/mback2k/django-jdatetime]
- django-yamlcss [https://github.com/mback2k/django-yamlcss]

Message Broker
--------------
- Kombu [http://pypi.python.org/pypi/kombu/]

All Celery supported AMQP message brokers can be used.

Configuration
-------------
In order to use WebGCal the Django project needs to have a complete settings.py.
The following Django settings are required to run WebGCal:

- BROKER_URL and other required message broker settings
- DATABASES
- DEFAULT_FROM_EMAIL
- SECRET_KEY

All other settings are pre-configured inside settings/base.py, which can be imported using the following line in your settings/{env}.py:

from .base import *

A basic development environment can be launched using the pre-configured settings/dev.py.

Installation
------------
First of all you need to install all the dependencies.
It is recommended to perform the installations using the pip command.

The next step is to get all source from github.com and PyPI:

git clone --recursive https://github.com/mback2k/django-webgcal.git webgcal

cd webgcal

pip install -r requirements.txt

After that you need to collect and compress the static files using:

python manage.py collectstatic --noinput
python manage.py compress --force

Now you need to setup your webserver to serve the Django project.
Please take a look at the [Django documentation](https://docs.djangoproject.com/en/1.8/topics/install/) for more information.

You can run a development server using the following command:

python manage.py runserver

Executing Tasks
---------------
Besides running the webserver, you need to run celery beat and celery worker.
You can do this by executing the following commands from your server's shell:

celery -A webgcal beat
celery -A webgcal worker

License
-------
* Released under MIT License
* Copyright (c) 2012-2016 Marc Hoersken