A web based calendar application for Fedora
Python HTML JavaScript CSS Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
alembic
doc
fedmsg.d
fedocal
tests
.gitignore
LICENSE
MANIFEST.in
README.rst
TODO
alembic.ini.sample
babel.cfg
createdb
createdb.py
fedocal.cfg.sample
fedocal.conf
fedocal.spec
fedocal.wsgi
fedocal_cron.py
messages.pot
nosetests
requirements.txt
run_pylint.sh
run_tests.sh
runserver.py
setup.py
update.sql

README.rst

fedocal

Author: Pierre-Yves Chibon <pingou@pingoured.fr>

fedocal is a web based calendar application.

Get this project:

Source: https://pagure.io/fedocal Mirror on github: https://github.com/fedora-infra/fedocal (Please use Pagure as the main repository and make sure you run your patch against it)

Documentation: http://fedocal.rtfd.org

Dependencies:

This project is a Flask application. The calendars and meetings are stored into a relational database using SQLAlchemy as Object Relational Mapper (ORM) and alembic to handle database scheme changes. fedocal provides an iCal feed for each calendar and relies on python-vobject for this. Finally, pytz is used to handle the timezone changes and dateutil to allow date manipulation over months/years.

The dependency list is therefore:

Running a development instance:

Clone the source:

git clone https://github.com/fedora-infra/fedocal.git

Copy the configuration files:

cp fedocal.cfg.sample fedocal.cfg
cp alembic.ini.sample alembic.ini

Adjust the configuration file (secret key, database URL, admin group...)

Create the database scheme:

FEDOCAL_CONFIG=fedocal.cfg sh createdb

Run the server:

FEDOCAL_CONFIG=`pwd`/fedocal.cfg python runserver.py

You should be able to access the server at http://localhost:5000

Note

the part FEDOCAL_CONFIG=fedocal.cfg is only really needed if you run fedocal on a dedicated database instead of the default sqlite one.

Testing:

This project contains unit-tests allowing you to check if your server has all the dependencies correctly set.

To run them:

./run_tests.sh

Note

To stop the test at the first error or failure you can try:

./run_tests.sh -x

Reporting issues:

For any issue you may encounter please file a ticket and submit it to:

Fedocal Pagure: https://pagure.io/fedocal/issues

Contributors can use the same tracker to find existing bugs to work on. You need to login with your FAS account to submit or modify a ticket.

License:

This project is licensed GPLv3+.