openslides-votecollector 1.0.4

=====================================
VoteCollector Plugin for OpenSlides
=====================================


Overview
========

This plugin connects OpenSlides with the software "VoteCollector"
to provide electronic voting for motions with Keypads from `Voteworks <http://www.voteworks.de>`_.

The VoteCollector plugin for OpenSlides was contracted by the German
company Voteworks. It was initially developed by the core authors of
OpenSlides, Oskar Hahn and Emanuel Schütze (`Intevation GmbH <http://www.intevation.de/>`_), in April 2012.


Requirements
============

OpenSlides 1.5.x (http://openslides.org/)


Install
=======

I. Installation on Windows (with OpenSlides portable version)
-------------------------------------------------------------

1. Install and run VoteCollector

Download VoteColletor from http://www.keypaddepot.de/de/Wahlen/VoteCollector-App-nur-Plug-In-zu-OpenSlides.html
(via tab "Medien").

To use VoteCollector in simulation mode (no keypads required)
please run from command line::

VoteCollector.exe -s

Note: You have to buy a license key for VoteCollector to use more than 5 keypads.

2. Get latest VoteCollector plugin release from:

https://github.com/OpenSlides/openslides-votecollector/tags

3. Move the (extracted) subdirectory 'votecollector' to::

'<path-to-openslides-portable>/site-packages/votecollector/'

4. If required: Run openslides.exe first time to create database and settings.py
file. Then stop OpenSlides.

5. Edit '<path-to-openslides-portable>/openslides/settings.py' and
add the plugin name 'votecollector' under 'INSTALLED_PLUGINS'::

INSTALLED_PLUGINS = (
'votecollector',
)

6. Start openslides.exe again.

7. Add VoteCollector permission to staff group:
Go to 'Participants > Groups' and edit the group 'Staff'.
Add the permission 'Can manage VoteCollector' and save the form.


Now the plugin installation is finished. You can open the new menu
item 'VoteCollector' in the main navigation of OpenSlides.

Change settings of plugin under 'Configuration > VoteCollector'.


II. Installation on GNU/Linux and MacOSX
----------------------------------------

1. Install and run VoteCollector (on Windows only, e.g. in a VirtualBox machine)

Download from http://www.keypaddepot.de/de/Wahlen/VoteCollector-App-nur-Plug-In-zu-OpenSlides.html
(via tab "Medien").

To use VoteCollector in simulation mode (no keypads required)
please run from command line::

VoteCollector.exe -s

Note: You have to buy a license key for VoteCollector to use more than 5 keypads.

2. Setup and activate a virtual environment::

$ virtualenv .virtualenv

$ source .virtualenv/bin/activate

3. Install OpenSlides and VoteCollector plugin from the Python Package Index (PyPI)::

$ pip install openslides-votecollector

OpenSlides and all required python packages will be installed.

4. Run OpenSlides first time to create database and settings.py file::

$ openslides

Stop OpenSlides with CTRL + C.

5. Edit '~/.config/openslides/settings.py' and add the plugin
name 'votecollector' under 'INSTALLED_PLUGINS'::

INSTALLED_PLUGINS = (
'votecollector',
)

6. Restart OpenSlides::

$ openslides

7. Add VoteCollector permission to staff group:
Go to 'Participants > Groups' and edit the group 'Staff'.
Add the permission 'Can manage VoteCollector' and save the form.


Now the plugin installation is finished. You can open the new menu
item 'VoteCollector' in the main navigation of OpenSlides.

Change settings of plugin under 'Configuration > VoteCollector'.


License
=======

This plugin is released under the MIT License, see LICENSE file.


Changelog
=========

Version 1.0.4 (2013-12-04)
--------------------------
* Updated to OpenSlides 1.5.x.
* Added README and requirements.txt.
* Added fabfile and unit tests.
* Changed license to MIT.

Version 1.0.3 (2012-12-14)
--------------------------
* Updated INSTALL.txt.
* Added setup.py for easier install.

Version 1.0.2 (2012-12-12)
--------------------------
* Updated to OpenSlides 1.3.x.

Version 1.0.1 (2012-07-25)
--------------------------
* Updated to OpenSlides 1.2.x.

Version 1.0 (2012-05-21)
--------------------------
* First release of this plugin for OpenSlides 1.1.x.