README.rst

OpenSlides

What is OpenSlides?

OpenSlides is a free, web based presentation and assembly system for managing and projecting agenda, motions and elections of an assembly. See https://openslides.org/ for more information.

Requirements2

OpenSlides runs everywhere where Python is running (for example on GNU/Linux, Mac or Windows (XP or newer)). On each client you need only a current version of a webbrowser.

Installation

1. Installation on GNU/Linux or Mac OS X

a. Check requirements

Make sure that you have installed Python (>= 3.4) on your system. You also need the Python development headers, the Independent JPEG Group's JPEG runtime library (dependency package) and the compression library (development).

E. g. for Ubuntu run:

$ sudo apt-get install python3-dev libjpeg-dev zlib1g-dev

b. Setup a virtual Python environment (optional)

You can setup a virtual Python environment using the virtual environment (venv) package for Python to install OpenSlides as non-root user.

Note: For Ubuntu 14.04 you have to install the pyvenv binary package python3.4-venv before.

Create your OpenSlides directory, change to it, setup and activate the virtual environment:

$ mkdir OpenSlides
$ cd OpenSlides
$ python3 -m venv .virtualenv
$ source .virtualenv/bin/activate

c. Install OpenSlides

To install OpenSlides just run:

$ pip install openslides

You can also use the package from the OpenSlides website. Download latest OpenSlides release as compressed tar archive and run:

$ pip install openslides-x.x.tar.gz

This will install all required Python packages (see requirements_production.txt).

d. Start OpenSlides

To start OpenSlides simply run:

$ openslides

If you run this command the first time, a new database and the admin account (Username: admin, Password: admin) will be created. Please change the password after first login!

OpenSlides will start using the integrated Tornado webserver. It will also try to open the webinterface in your default webbrowser. The server will try to listen on the local ip address on port 8000. That means that the server will be available to everyone on your local network (at least for commonly used network configurations).

If you use a virtual environment (see step b.), do not forget to activate the environment before restart after you have closed the terminal:

$ source .virtualenv/bin/activate

To get help on the command line options run:

$ openslides --help

You can store settings, database and other personal files in a local subdirectory and use these files e. g. if you want to run multiple instances of OpenSlides:

$ openslides --local-installation

2. Installation on Windows

Download the latest portable version of OpenSlides for Windows from OpenSlides website which does not require any install steps. Simply unzip the downloaded file and run openslides.exe.

Development

If you want to contribute to OpenSlides, have a look at OpenSlides website and write us an email. There is also an instruction to install the development version.

Used software

OpenSlides uses the following projects or parts of them:

• backports-abc, License: Python Software Foundation License
• Beautiful Soup, License: MIT
• Django, License: BSD
• Django REST framework, License: BSD
• html5lib, License: MIT
• django-jsonfield, License: MIT
• natsort, License: MIT
• PyPDF2, License: BSD
• ReportLab, License: BSD
• roman, License: Python 2.1.1
• setuptools, License: Python Software Foundation License
• Six, License: MIT
• sockjs-tornado, License: MIT
• Tornado, License: Apache License v2.0
• Whoosh, License: BSD
• Several JavaScript packages (see bower.json)
  • angular, License: MIT
  • angular-animate, License: MIT
  • angular-bootstrap, License: MIT
  • angular-bootstrap-colorpicker, License: MIT
  • angular-chosen-localytics, License: MIT
  • angular-csv-import-tmp, License: MIT
  • angular-formly, License: MIT
  • angular-formly-templates-bootstrap, License: MIT
  • angular-gettext, License: MIT
  • angular-loading-bar, License: MIT
  • angular-messages, License: MIT
  • angular-pdf, License: MIT
  • angular-sanitize, License: MIT
  • angular-scroll-glue, License: MIT
  • angular-ui-router, License: MIT
  • angular-ui-tinymce, License: MIT
  • angular-ui-tree, License: MIT
  • api-check, License: MIT
  • bootstrap, License: MIT
  • chosen, License: MIT
  • font-awesome-bower, License: MIT
  • jquery, License: MIT
  • jquery.cookie, License: MIT
  • js-data, License: MIT
  • js-data-angular, License: MIT
  • js-data-http, License: MIT
  • lodash, License: MIT
  • ng-dialog, License: MIT
  • ng-file-upload, License: MIT
  • ngbootbox, License: MIT
  • open-sans-fontface, License: Apache License version 2.0
  • pdfjs-dist, License: Apache-2.0
  • roboto-condensed, License: Apache 2.0
  • sockjs, License: MIT
  • tinymce, License: LGPL-2.1
  • tinymce-i18n, License: LGPL-2.1

License and authors

OpenSlides is Free/Libre Open Source Software (FLOSS), and distributed under the MIT License, see LICENSE file. The authors of OpenSlides are mentioned in the AUTHORS file.