Uniform access to data sources and services
Go to file
Frédéric Péters 9e504d4412 debian: fix typo in python-httplib2 package name 2019-10-15 11:57:13 +02:00
debian debian: fix typo in python-httplib2 package name 2019-10-15 11:57:13 +02:00
functests cmis: upgrade cmislib 0.6 (#18407) 2019-10-15 10:48:52 +02:00
passerelle translation update 2019-10-15 11:41:07 +02:00
tests base resource: add automatic 'up' endpoint (#21978) 2019-10-15 11:01:30 +02:00
.coveragerc add .coveragerc to omit south_migrations/ directories 2015-04-17 16:00:55 +02:00
.gitignore add utilities to call w.c.s. APIs (#32656) 2019-04-29 11:42:41 +02:00
Jenkinsfile jenkins: use ci@entrouvert.org for notifications 2019-10-02 14:08:47 +02:00
LICENSE this will be AGPL 2013-02-11 11:04:19 +01:00
MANIFEST.in sp_fr: distribute XSD files (#31595) 2019-04-29 17:16:30 +02:00
README misc: remove legal info of deleted icon file (#21134) 2018-01-12 08:41:57 +01:00
config_example.py New organization of settings 2014-10-02 09:54:39 +02:00
get_wcs.sh add utilities to call w.c.s. APIs (#32656) 2019-04-29 11:42:41 +02: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 pylint.sh: remove "set -x" 2018-11-28 17:01:02 +01:00
requirements.txt update dependances, accepting django 1.11 (#19890) 2017-11-29 01:07:58 +01:00
setup.py cmis: upgrade cmislib 0.6 (#18407) 2019-10-15 10:48:52 +02:00
tox.ini drop sqlite in default tox.ini envlist (#36106) 2019-09-16 17:34:09 +02:00

README

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

From Passerelle source directory install required Python packages:

    $ pip install -e .

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

To create the database, execute the following line:

    $ python manage.py migrate

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

Create a first user with administrative rights:

    $ python manage.py createsuperuser


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 django18 -- 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/>.


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