passerelle

Uniform access to data sources and services

Go to file

Benjamin Dauvergne 24ab67af34 Add 'debian/' from commit 'cd367dca1b743666174862dc659b2276ce01cf1b' git-subtree-dir: debian git-subtree-mainline: `0f929813d6` git-subtree-split: `cd367dca1b`		2015-04-22 10:32:15 +02:00
debian	Add 'debian/' from commit 'cd367dca1b743666174862dc659b2276ce01cf1b'	2015-04-22 10:32:15 +02:00
passerelle	add settings.PASSERELLE_APPS (#6900 )	2015-04-14 10:01:56 +02:00
tests	tests: don't use deprecated status_code	2015-04-03 22:32:48 +02:00
.coveragerc	add .coveragerc to omit south_migrations/ directories	2015-04-17 16:00:55 +02:00
.gitignore	minimalistic homepage view	2013-02-15 14:48:13 +01:00
LICENSE	this will be AGPL	2013-02-11 11:04:19 +01:00
MANIFEST.in	include pastell static files	2014-09-18 14:08:51 +02:00
README	tests: switch to py.test, convert sms tests	2015-04-03 22:05:57 +02:00
config_example.py	New organization of settings	2014-10-02 09:54:39 +02:00
jenkins.sh	jenkins: run py.test	2015-04-03 22:25:14 +02:00
manage.py	settings: changed to single file, with a execfile() tacked at the end (#6465 )	2015-02-10 13:06:55 +01:00
requirements.txt	misc: force Django 1.7 for now	2015-04-03 22:30:50 +02:00
setup.py	misc: force Django 1.7 for now	2015-04-03 22:30:50 +02:00

README

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Passerelle provides an uniform access to multiple data sources and services.

Quickstart
==========

Setting up an environment (virtualenv)
--------------------------------------

The first thing you'll need is the Python virtualenv package. You probably
already have this, but if not, you can install it with:

    $ easy_install -UZ virtualenv

Once that's done, choose a location for the environment, and create it with the
virtualenv command. For our guide, we're going to choose "venv" in the current
directory:

    $ virtualenv venv
    $ source venv/bin/activate

Install required Python packages:

    $ pip install -r requirements.txt

Initializing the database (quickstart: sqlite3)
-----------------------------------------------

To create the database, execute the following line:

    $ python manage.py syncdb --migrate

The new database is created inside `passerelle.sqlite3` in the current
directory.

Running
-------

The command line for starting is:

    $ python manage.py runserver

Passerelle is available on http://127.0.0.1:8000/


Settings
--------

Default settings are loaded from settings.py, they can be overloaded by a
local_settings.py file set in the same directory, or by a file referenced
in the PASSERELLE_SETTINGS_FILE environment variable.


Tests
-----

Unit tests are written using py.test, and its pytest-django support library.

  DJANGO_SETTINGS_MODULE=passerelle.settings \
  PASSERELLE_SETTINGS_FILE=tests/settings.py \
  py.test tests/

LICENSES
========

Passerelle
Copyright (C) 2013-2014 Entr'ouvert <info@entrouvert.com>

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
details.

You should have received a copy of the GNU Affero General Public License along
with this program (LICENSE file). If not, see <http://www.gnu.org/licenses/>.


icons
-----

icon-concerto.svg license:
Creative Commons – Attribution (CC BY 3.0) http://creativecommons.org/licenses/by/3.0/us/
"Family" designed by Ahmed Elzahra http://www.thenounproject.com/trochilidae/
from the Noun Project http://www.thenounproject.com/

README Unescape Escape

README