Repository :
http://git.fedorahosted.org/cgit/fedocal.git
On branch : master
---------------------------------------------------------------
commit 92b4b46ecdd488d05b31dd395e935176998d512b
Author: Pierre-Yves Chibon <pingou(a)pingoured.fr>
Date: Tue Dec 11 19:44:32 2012 +0100
Update the README
To avoid duplication of documentation, update the README to link to the official
documentation remove the deployement instructions, remove the alembic information
since both are in the documentation.
Keep the list of dependencies in there as this is useful to have within the sources.
---------------------------------------------------------------
README.rst | 83 ++++++------------------------------------------------------
1 files changed, 8 insertions(+), 75 deletions(-)
diff --git a/README.rst b/README.rst
index bd76d66..f3b3874 100644
--- a/README.rst
+++ b/README.rst
@@ -11,6 +11,7 @@ Get this project:
-----------------
Source:
https://github.com/pypingou/fedocal
+Documentation:
http://fedocal.rtfd.org
Dependencies:
@@ -28,13 +29,15 @@ Dependencies:
.. _alembic:
https://bitbucket.org/zzzeek/alembic
.. _python-alembic:
http://pypi.python.org/pypi/alembic
.. _pytz:
http://pytz.sourceforge.net/
+.. _dateutil:
http://labix.org/python-dateutil
+.. _python-dateutil:
http://pypi.python.org/pypi/python-dateutil
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.
+changes and `dateutil`_ to allow date manipulation over months/years.
The dependency list is therefore:
@@ -48,6 +51,7 @@ The dependency list is therefore:
- `python-kitchen`_
- `python-alembic`_
- `pytz`_
+- `python-dateutil`_
Running a development instance:
@@ -76,61 +80,6 @@ Run the server::
You should be able to access the server at
http://localhost:5000
-Deploying this project:
------------------------
-
-.. _Flask deployment documentation:
http://flask.pocoo.org/docs/deploying/
-
-Instruction to deploy this application is available on the
-`Flask deployment documentation`_ page.
-
- **My approach.**
-
-Below is the approach I took to deploy the instance on a local (test) machine.
-
-
-Retrieve the sources::
-
- cd /srv/
- git clone <repo>
- cd fedocal
-
-
-Copy the configuration file::
-
- cp fedocal.cfg.sample fedocal.cfg
-
-Adjust the configuration file (secret key, database URL, admin group...)
-
-Create the database scheme::
-
- python fedocal/fedocallib/model.py
-
-
-Then configure apache::
-
- sudo vim /etc/httd/conf.d/wsgi.conf
-
-and put in this file::
-
- WSGIScriptAlias /fedocal /var/www/wsgi/fedocal.wsgi
- <Directory /var/www/wsgi/>
- Order deny,allow
- Allow from all
- </Directory>
-
-Then create the file /var/www/wsgi/fedocal.wsgi with::
-
- import sys
- sys.path.insert(0, '/srv/fedocal/')
-
- import fedocal
- application = fedocal.APP
-
-
-Then restart apache and you should be able to access the website on
-http://localhost/fedocal
-
Testing:
--------
@@ -142,27 +91,11 @@ To run them::
./run_tests.sh
+.. note:: To stop the test at the first error or failure you can try:
-Database changes:
------------------
-.. _alembic tutorial:
http://alembic.readthedocs.org/en/latest/tutorial.html
-
-The database changes are handled via `alembic`.
-
-
-If you are deploying fedocal for the first time, you will not need this,
-however, if you already have a running fedocal but the database scheme
-is not up to date, then you will have to run::
-
-
- alembic upgrade head
-
-.. note:: If this is the first time you are running ``alembic``, you will
- need to copy file ``alembic.ini.sample`` to ``alembic.ini`` and setup
- the ``sqlalchemy.url`` variable in the latest
-
+ ::
-If you are a developer, you probably want to have a look at the `alembic tutorial`_
+ ./run_tests.sh -x
License: