| 1 |
About |
|---|
| 2 |
===== |
|---|
| 3 |
|
|---|
| 4 |
A web application for threading together 'factlets' into narratives organized |
|---|
| 5 |
by theme, time and space. |
|---|
| 6 |
|
|---|
| 7 |
Copyright and License |
|---|
| 8 |
===================== |
|---|
| 9 |
|
|---|
| 10 |
Copyright 2007-2008 Open Knowledge Foundation. |
|---|
| 11 |
|
|---|
| 12 |
Licensed under the MIT license: |
|---|
| 13 |
|
|---|
| 14 |
Permission is hereby granted, free of charge, to any person obtaining a copy |
|---|
| 15 |
of this software and associated documentation files (the "Software"), to deal |
|---|
| 16 |
in the Software without restriction, including without limitation the rights |
|---|
| 17 |
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|---|
| 18 |
copies of the Software, and to permit persons to whom the Software is |
|---|
| 19 |
furnished to do so, subject to the following conditions: |
|---|
| 20 |
|
|---|
| 21 |
The above copyright notice and this permission notice shall be included in |
|---|
| 22 |
all copies or substantial portions of the Software. |
|---|
| 23 |
|
|---|
| 24 |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|---|
| 25 |
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|---|
| 26 |
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|---|
| 27 |
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|---|
| 28 |
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|---|
| 29 |
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
|---|
| 30 |
THE SOFTWARE. |
|---|
| 31 |
|
|---|
| 32 |
Contributors |
|---|
| 33 |
============ |
|---|
| 34 |
|
|---|
| 35 |
* Rufus Pollock |
|---|
| 36 |
* Nick Stenning |
|---|
| 37 |
* John Bywater |
|---|
| 38 |
|
|---|
| 39 |
Also especial thanks to the following projects without whom this would not have |
|---|
| 40 |
been possible: |
|---|
| 41 |
|
|---|
| 42 |
* famfamfam.com silk icons <http://www.famfamfam.com/lab/icons/silk/> |
|---|
| 43 |
* Mootools: <http://mootools.net/> |
|---|
| 44 |
* Pylons: <http://pylonshq.com/> |
|---|
| 45 |
|
|---|
| 46 |
Installation and Setup |
|---|
| 47 |
====================== |
|---|
| 48 |
|
|---|
| 49 |
Install ``microfacts`` using easy_install:: |
|---|
| 50 |
|
|---|
| 51 |
easy_install microfacts |
|---|
| 52 |
|
|---|
| 53 |
You will also need to install the additional (non-python) dependencies for |
|---|
| 54 |
Shapely listed on: <http://trac.gispython.org/lab/wiki/Shapely>. |
|---|
| 55 |
|
|---|
| 56 |
Make a config file as follows:: |
|---|
| 57 |
|
|---|
| 58 |
paster make-config microfacts config.ini |
|---|
| 59 |
|
|---|
| 60 |
Tweak the config file as appropriate and then setup the application:: |
|---|
| 61 |
|
|---|
| 62 |
paster setup-app config.ini |
|---|
| 63 |
|
|---|
| 64 |
Then you are ready to start the web application:: |
|---|
| 65 |
|
|---|
| 66 |
paster server config.ini |
|---|
| 67 |
|
|---|
| 68 |
|
|---|
| 69 |
Developers |
|---|
| 70 |
========== |
|---|
| 71 |
|
|---|
| 72 |
You should copy the example environment files and customize them to your |
|---|
| 73 |
liking:: |
|---|
| 74 |
|
|---|
| 75 |
cp test.ini.example test.ini |
|---|
| 76 |
cp development.ini.example development.ini |
|---|
| 77 |
vim development.ini |
|---|
| 78 |
|
|---|
| 79 |
You can then run a server like this:: |
|---|
| 80 |
|
|---|
| 81 |
paster server development.ini --reload & |
|---|
| 82 |
|
|---|
| 83 |
The tests can be run with:: |
|---|
| 84 |
|
|---|
| 85 |
nosetests microfacts/tests |
|---|
| 86 |
|
|---|
