Uniform access to data sources and services
Go to file
Benjamin Dauvergne 5461298c66 run pylint inside tox 2016-06-09 16:37:30 +02:00
debian debian/init.d: non-interactive migrations (#10877) 2016-05-16 12:36:10 +02:00
passerelle general: add a generic connector view (#11200) 2016-06-09 14:44:42 +02:00
tests general: add generic endpoint view (#11204) 2016-06-09 14:44:42 +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 MANIFEST.in: include README files 2015-12-03 14:53:42 +01:00
README embed jsonresponse into the package (#10283) 2016-04-13 18:02:42 +02:00
config_example.py New organization of settings 2014-10-02 09:54:39 +02:00
getmagic.sh jenkins.sh: remove useless pip install calls 2016-03-10 16:05:27 +01:00
jenkins.sh run pylint inside tox 2016-06-09 16:37:30 +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
pylint.sh run pylint inside tox 2016-06-09 16:37:30 +02:00
requirements.txt add suds in requirements and debian/recommends 2015-06-12 00:28:54 +02:00
setup.py setup.py: allow running with Django >= 1.8 2016-06-09 16:37:30 +02:00
tox.ini run pylint inside tox 2016-06-09 16:37:30 +02:00

README

This file contains ambiguous Unicode characters

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 and
run using tox.

  tox

To run a specific test under a specific environment.

  tox -e django17 -- tests/test_csv_datasource.py

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/


Copyright
---------

django-jsonresponse (https://github.com/jjay/django-jsonresponse)
 # Files: passerelle/utils/jsonresponse.py
 # Copyright (c) 2012 Yasha Borevich <j.borevich@gmail.com>
 # Licensed under the BSD license