Added flag to use Geiss. Small changes for the new getgeiss command. Changed path of collected statics.

.travis.yml

@@ -28,6 +28,6 @@ script:
   - coverage report --fail-under=44
 
   - DJANGO_SETTINGS_MODULE='tests.settings' coverage run ./manage.py test tests.integration
-  - coverage report --fail-under=70
+  - coverage report --fail-under=73
 
   - DJANGO_SETTINGS_MODULE='tests.old.settings' ./manage.py test tests.old

README.rst

@@ -47,6 +47,7 @@ virtual environment::
     $ cd OpenSlides
     $ python3 -m venv .virtualenv
     $ source .virtualenv/bin/activate
+    $ pip install -U setuptools
 
 
 c. Install OpenSlides

openslides/__main__.py

@@ -101,6 +101,7 @@ def get_parser():
         'start',
         description=start_help,
         help=start_help)
+    subcommand_start.set_defaults(callback=start)
     subcommand_start.add_argument(
         '--no-browser',
         action='store_true',
@@ -120,11 +121,14 @@ def get_parser():
         action='store',
         default=None,
         help='The used settings file. The file is created, if it does not exist.')
-    subcommand_start.set_defaults(callback=start)
     subcommand_start.add_argument(
         '--local-installation',
         action='store_true',
         help='Store settings and user files in a local directory.')
+    subcommand_start.add_argument(
+        '--use-geiss',
+        action='store_true',
+        help='Use Geiss instead of Daphne as ASGI protocol server.')
 
     # Subcommand createsettings
     createsettings_help = 'Creates the settings file.'
@@ -183,13 +187,13 @@ def start(args):
     django.setup()
     from django.conf import settings
 
+    # Migrate database
     call_command('migrate')
 
-    use_geiss = True
+    if args.use_geiss:
-    if use_geiss:
+        # Make sure Redis is used.
-        # Make sure redis is used.
         if settings.CHANNEL_LAYERS['default']['BACKEND'] != 'asgi_redis.RedisChannelLayer':
-            raise RuntimeError("You have to use the asgi redis backend in the settings to use Geiss.")
+            raise RuntimeError("You have to use the ASGI Redis backend in the settings to use Geiss.")
 
         # Download Geiss and collect the static files.
         call_command('getgeiss')
@@ -208,8 +212,8 @@ def start(args):
             '--static', '/media/:{}'.format(settings.MEDIA_ROOT),
         ])
 
-        # Start one worker in this thread. There can be only one worker as long
+        # Start one worker in this thread. There can be only one worker as
-        # as sqlite is used.
+        # long as SQLite3 is used.
         call_command('runworker')
 
     else:
@@ -217,16 +221,24 @@ def start(args):
         if not args.no_browser:
             open_browser(args.host, args.port)
 
-        # Start the webserver
+        # Start Daphne and one worker
+        #
         # Use flag --noreload to tell Django not to reload the server.
+        # Therefor we have to set the keyword noreload to False because Django
+        # parses this directly to the use_reloader keyword.
+        #
         # Use flag --insecure to serve static files even if DEBUG is False.
-        # Use flag --nothreading to tell Django Channels to run in single thread mode.
+        #
+        # Use flag --nothreading to tell Django Channels to run in single
+        # thread mode with one worker only. Therefor we have to set the keyword
+        # nothreading to False because Django parses this directly to
+        # use_threading keyword.
         call_command(
             'runserver',
             '{}:{}'.format(args.host, args.port),
-            noreload=True,
+            noreload=False,  # Means True, see above.
             insecure=True,
-            nothreading=True,
+            nothreading=False,  # Means True, see above.
         )
 
 

openslides/core/management/commands/getgeiss.py

@@ -16,19 +16,19 @@ class Command(BaseCommand):
     help = 'Get the latest Geiss release from GitHub.'
 
     def handle(self, *args, **options):
-        geiss_name = get_geiss_name()
+        geiss_github_name = self.get_geiss_github_name()
         download_file = get_geiss_path()
 
         if os.path.isfile(download_file):
-            # Geiss does probably exist. Do Nothing.
+            # Geiss does probably exist. Do nothing.
             # TODO: Add an update flag, that downloads geiss anyway.
             return
 
-        response = urlopen(get_geiss_url()).read()
+        response = urlopen(self.get_geiss_url()).read()
         release = json.loads(response.decode())
         download_url = None
         for asset in release['assets']:
-            if asset['name'] == geiss_name:
+            if asset['name'] == geiss_github_name:
                 download_url = asset['browser_download_url']
                 break
         if download_url is None:
@@ -40,34 +40,36 @@ class Command(BaseCommand):
         st = os.stat(download_file)
         os.chmod(download_file, st.st_mode | stat.S_IEXEC)
 
+        self.stdout.write(self.style.SUCCESS('Geiss successfully downloaded.'))
 
-def get_geiss_url():
+    def get_geiss_url(self):
-    """
+        """
-    Returns the URL to the API which gives the information which geiss binary
+        Returns the URL to the API which gives the information which Geiss
-    has to be downloaded.
+        binary has to be downloaded.
 
-    Currently this is a static github-url to the repo where geiss is at the
+        Currently this is a static GitHub URL to the repository where geiss
-    moment. Could be changed to use a setting or a flag in the future.
+        is hosted at the moment.
-    """
+        """
-    return 'https://api.github.com/repos/ostcar/geiss/releases/latest'
+        # TODO: Use a settings variable or a command line flag in the future.
+        return 'https://api.github.com/repos/ostcar/geiss/releases/latest'
 
+    def get_geiss_github_name(self):
+        """
+        Returns the name of the Geiss executable for the current operating
+        system.
 
-def get_geiss_name():
+        For example geiss_windows_64 on a windows64 platform.
-    """
+        """
-    Returns the name of the Geiss executable for the current operating system.
+        # This will be 32 if the current python interpreter has only
+        # 32 bit, even if it is run on a 64 bit operating sysem.
+        bits = '64' if sys.maxsize > 2**32 else '32'
 
-    For example geiss_windows_64.exe on a windows64 platform.
+        geiss_names = {
-    """
+            'linux': 'geiss_linux_{bits}',
-    # This will be 32 if the current python interpreter has only
+            'win32': 'geiss_windows_{bits}.exe',  # Yes, it is win32, even on a win64 system!
-    # 32 bit, even if it is run on a 64 bit operating sysem.
+            'darwin': 'geiss_mac_{bits}'}
-    bits = '64' if sys.maxsize > 2**32 else '32'
 
-    geiss_names = {
+        try:
-        'linux': 'geiss_linux_{bits}',
+            return geiss_names[sys.platform].format(bits=bits)
-        'win32': 'geiss_windows_{bits}.exe',  # Yes, it is win32, even on a win64 system!
+        except KeyError:
-        'darwin': 'geiss_mac_{bits}'}
+            raise CommandError("Plattform {} is not supported by Geiss".format(sys.platform))
-
-    try:
-        return geiss_names[sys.platform].format(bits=bits)
-    except KeyError:
-        raise CommandError("Plattform {} is not supported by Geiss".format(sys.platform))

openslides/global_settings.py

@@ -81,8 +81,6 @@ LOCALE_PATHS = [
 
 STATIC_URL = '/static/'
 
-STATIC_ROOT = os.path.join(MODULE_DIR, '..', 'collected-static')
-
 STATICFILES_DIRS = [
     os.path.join(MODULE_DIR, 'static'),
 ]
@@ -134,6 +132,7 @@ CACHES = {
 
 # Django Channels
 # http://channels.readthedocs.io/en/latest/
+# https://github.com/ostcar/geiss
 
 CHANNEL_LAYERS = {
     'default': {

openslides/utils/main.py

@@ -261,6 +261,18 @@ def write_settings(settings_path=None, template=None, **context):
     return os.path.realpath(settings_path)
 
 
+def open_browser(host, port):
+    """
+    Launches the default web browser at the given host and port and opens
+    the webinterface. Uses start_browser internally.
+    """
+    if host == '0.0.0.0':
+        # Windows does not support 0.0.0.0, so use 'localhost' instead
+        start_browser('http://localhost:%s' % port)
+    else:
+        start_browser('http://%s:%s' % (host, port))
+
+
 def start_browser(browser_url):
     """
     Launches the default web browser at the given url and opens the
@@ -281,14 +293,6 @@ def start_browser(browser_url):
         thread.start()
 
 
-def open_browser(host, port):
-    if host == '0.0.0.0':
-        # Windows does not support 0.0.0.0, so use 'localhost' instead
-        start_browser('http://localhost:%s' % port)
-    else:
-        start_browser('http://%s:%s' % (host, port))
-
-
 def get_database_path_from_settings():
     """
     Retrieves the database path out of the settings file. Returns None,
@@ -335,7 +339,7 @@ def is_local_installation():
 
 def get_geiss_path():
     """
-    Returns the path and file to the geis binary.
+    Returns the path and file to the Geiss binary.
     """
     from django.conf import settings
     download_path = getattr(settings, 'OPENSLIDES_USER_DATA_PATH', '')
@@ -345,6 +349,6 @@ def get_geiss_path():
 
 def is_windows():
     """
-    Returns True when the current system is windows. Returns False otherwise.
+    Returns True if the current system is Windows. Returns False otherwise.
     """
     return sys.platform == 'win32'

openslides/utils/settings.py.tpl

@@ -123,6 +123,8 @@ TIME_ZONE = 'Europe/Berlin'
 
 STATICFILES_DIRS = [os.path.join(OPENSLIDES_USER_DATA_PATH, 'static')] + STATICFILES_DIRS
 
+STATIC_ROOT = os.path.join(OPENSLIDES_USER_DATA_PATH, 'collected-static')
+
 
 # Files
 # https://docs.djangoproject.com/en/1.10/topics/files/

setup.cfg

@@ -1,5 +1,6 @@
 [coverage:run]
 source = openslides
+omit = openslides/core/management/commands/getgeiss.py
 
 [coverage:html]
 directory = personal_data/tmp/htmlcov