Create project management command

Author: einarf

TODO.md

@@ -4,14 +4,21 @@
 - Split up README into several files
 - Properly verify all settings
 - Write documentation (readthedocs)
+- Make EffectControllers
+  - SingleEffectController
+  - TrackSystemEffectController
+  - SimpleTimeLineEffectController
 - CLI tool creating new projects and effects.
 - Create more examples in demosys_test
 - Shaders
+  - Improve error prints (use actual source from GL so we can see expanded typedefs)
   - Core loader support for common formats
   - Custom loader support / less hacky loading
 Textures:
-  - Support 1D and 3D textures
-  - Custom texture loaders
+  - 1D and 3D
+  - Texture Array
+  - Texture Cube
+- Custom texture loaders
 - FBOs
   - Support layers
 Generic Data:
@@ -25,4 +32,5 @@ Generic Data:
   - FBOs
   - Textures
 - Settings entry for key bindings
-- Clean up cotroller/initialization
+- Clean up controller/initialization
+- Look into using freetype

demosys/conf/default_settings.py

@@ -2,6 +2,10 @@
 Default settings for demosys. Override using a settings module.
 """
 
+# What attributes should be used when generating a settings file
+__ORDER__ = ('DEBUG', 'SCREENSHOT_PATH', 'OPENGL', 'WINDOW', 'EFFECTS', 'MUSIC',
+             'SHADER_DIRS', 'SHADER_FINDERS', 'TEXTURE_DIRS', 'TEXTURE_FINDERS')
+
 DEBUG = False
 
 SCREENSHOT_PATH = None

demosys/conf/settingsfile.py

@@ -0,0 +1,28 @@
+
+
+def create(settings):
+    """
+    Return a string representation of the settings.
+    This is an extremely ugly way of doing this, but it works for now!
+    """
+    # FIXME: Use a template system for generating settings file
+    data = "# Auto generated settings file\n" \
+           "import os\n" \
+           "PROJECT_DIR = os.path.dirname(os.path.abspath(__file__))\n\n"
+    for name in settings.__ORDER__:
+        value = getattr(settings, name)
+        if isinstance(value, dict):
+            value = ",\n".join('    "{}": {}'.format(k, to_s(v)) for k, v in value.items())
+            data += "%s = {\n%s\n}\n\n" % (name, value)
+        elif isinstance(value, tuple):
+            value = ",\n".join("    {}".format(to_s(v)) for v in value)
+            data += f"{name} = (\n{value})\n\n"
+
+    return data
+
+
+def to_s(t):
+    if isinstance(t, str):
+        return f'"{t}"'
+    else:
+        return str(t)

demosys/core/management/commands/createproject.py

@@ -0,0 +1,78 @@
+# FIXME: Rewrite this into something less horrible in the future
+# Right now we just want this to work
+import os
+from importlib import import_module
+
+HELP = "Create a project"
+
+
+def print_usage():
+    print("Usage:")
+    print("  crateproject <name>")
+
+
+def run(args):
+    if not args:
+        print_usage()
+        return
+
+    name = args[0]
+    print(f"Creating project '{name}'")
+
+    # Check for python module collision
+    try:
+        import_module(name)
+    except ImportError:
+        pass
+    else:
+        raise ValueError(f"{name} conflicts with an existing python module")
+
+    # Is the name a valid identifier?
+    validate_name(name)
+
+    # Make sure we don't mess with existing directories
+    if os.path.exists(name):
+        print(f"Directory {name} already exist. Aborting.")
+        return
+
+    # Create the project directory
+    os.makedirs(name)
+
+    # Use the default settings file
+    os.environ['DEMOSYS_SETTINGS_MODULE'] = 'demosys.conf.default_settings'
+    from demosys.conf import settings
+    from demosys.conf import settingsfile
+
+    with open(os.path.join(name, 'settings.py'), 'w') as fd:
+        fd.write(settingsfile.create(settings))
+
+    manage_file = 'manage.py'
+    with open(manage_file, 'w') as fd:
+        fd.write(gen_manage_py(name))
+
+    os.chmod(manage_file, 0o777)
+
+
+def validate_name(name):
+    if not name:
+        raise ValueError("Name cannot be empty")
+
+    # Can the name be used as an identifier in python (module or package name)
+    if not name.isidentifier():
+        raise ValueError(f"{name} is not a valid identifier")
+
+
+def gen_manage_py(project_name):
+    lines = [
+        '#!/usr/bin/env python3',
+        'import os',
+        'import sys',
+        '',
+        'if __name__ == "__main__":',
+        '    os.environ.setdefault("DEMOSYS_SETTINGS_MODULE", "{}.settings")'.format(project_name),
+        '',
+        '    from demosys.core.management import execute_from_command_line',
+        '',
+        '    execute_from_command_line(sys.argv)'
+    ]
+    return "\n".join(lines)

demosys_test/main.py

@@ -1,5 +1,5 @@
 """
-Entrypoint
+Entrypoint for custom entrypoint in setup.py
 """
 import os
 import sys

demosys_test/settings.py

@@ -21,7 +21,7 @@
     "resizable": True,
     "fullscreen": False,
     "title": "demosys-py",
-    "cursor": True,
+    "cursor": False,
 }
 
 MUSIC = os.path.join(PROJECT_DIR, 'resources/music/tg2035.mp3')