Implemented startplugin command

startplugin it's a command that generates the base of a Colab plugin. Just like django's startapp and startproject. Signed-off-by: Sergio Oliveira <sergio@tracy.com.br>

Implemented startplugin command
startplugin it's a command that generates the base of a Colab plugin. Just like django's startapp and startproject. Signed-off-by: Sergio Oliveira <sergio@tracy.com.br>
Sergio Oliveira · Diego Camarinha · Diego Camarinha
1 parent 31d4ac82
Showing 16 changed files with 225 additions and 0 deletions Show diff stats
colab/conf/__init__.py
colab/conf/plugin_template/setup.py
colab/conf/plugin_template/src/app_name/__init__.py
colab/conf/plugin_template/src/app_name/apps.py
colab/conf/plugin_template/src/app_name/data_importer.py
colab/conf/plugin_template/src/app_name/diazo.xml
colab/conf/plugin_template/src/app_name/models.py
colab/conf/plugin_template/src/app_name/search_indexes.py
colab/conf/plugin_template/src/app_name/urls.py
colab/conf/plugin_template/src/app_name/views.py
colab/conf/plugin_template/tests/__init__.py
colab/conf/plugin_template/tests/colab_settings.py
colab/conf/plugin_template/tests/plugins.d/app_name.py
colab/conf/plugin_template/tests/runtests.py
colab/conf/plugin_template/tests/test_plugin.py
colab/management/commands/startplugin.py
@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+"""
+{{ app_name_verbose }} Colab plugin
+===================================
+"""
+from setuptools import setup, find_packages
+
+install_requires = ['colab']
+
+tests_require = ['mock']
+
+
+setup(
+    name="{{ app_name_dash }}",
+    version='0.1.0',
+    author='<<Author Name>>',
+    author_email='<<Author email>>',
+    url='<< project url/repo url >>',
+    description='{{ app_name_verbose }} Colab plugin',
+    long_description=__doc__,
+    license='<< project license >>',
+    package_dir={'': 'src'},
+    packages=find_packages('src'),
+    zip_safe=False,
+    install_requires=install_requires,
+    test_suite="tests.runtests.run",
+    tests_require=tests_require,
+    extras_require={'test': tests_require},
+    include_package_data=True,
+    classifiers=[
+        'Framework :: Django',
+        'Intended Audience :: Developers',
+        'Intended Audience :: System Administrators',
+        'Operating System :: OS Independent',
+        'Topic :: Software Development'
+    ],
+)
@@ -0,0 +1,3 @@
+
+
+default_app_config = '{{ app_name }}.apps.PluginAppConfig'
@@ -0,0 +1,8 @@
+
+from colab.plugins.utils.apps import ColabPluginAppConfig
+
+
+class {{ app_name_camel }}AppConfig(ColabPluginAppConfig):
+    name = '{{ app_name }}'
+    verbose_name = '{{ app_name_verbose }} Plugin'
+    short_name = '{{ app_name }}'
@@ -0,0 +1,9 @@
+
+from colab.plugins.data import PluginDataImporter
+
+
+class {{ app_name_camel }}DataImporter(PluginDataImporter):
+    app_label = '{{ app_name }}'
+
+    def fetch_data(self):
+        pass
@@ -0,0 +1,6 @@
+<rules
+    xmlns="http://namespaces.plone.org/diazo"
+    xmlns:css="http://namespaces.plone.org/diazo/css"
+    xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+
+</rules>
@@ -0,0 +1 @@
+# Your models here.
@@ -0,0 +1,2 @@
+# Your search indexes here.
+#   See: http://django-haystack.readthedocs.org/en/latest/searchindex_api.html
@@ -0,0 +1,8 @@
+
+from django.conf.urls import patterns, url
+
+from .views import {{ app_name_camel }}ProxyView
+
+urlpatterns = patterns('',
+    url(r'^(?P<path>.*)$', GitlabProxyView.as_view(), name='{{ app_name }}'),
+)
@@ -0,0 +1,6 @@
+
+from colab.plugins.views import ColabProxyView
+
+
+class {{ app_name_camel }}ProxyView(ColabProxyView):
+    app_label = '{{ app_name }}'
@@ -0,0 +1,55 @@
+
+## Set to false in production
+DEBUG = True
+TEMPLATE_DEBUG = False
+
+## System admins
+ADMINS = [['John Foo', 'john@example.com'], ['Mary Bar', 'mary@example.com']]
+
+MANAGERS = ADMINS
+
+COLAB_FROM_ADDRESS = '"Colab" <noreply@example.com>'
+SERVER_EMAIL = '"Colab" <noreply@example.com>'
+
+EMAIL_HOST = 'localhost'
+EMAIL_PORT = 25
+EMAIL_SUBJECT_PREFIX = '[colab]'
+
+SECRET_KEY = 'not-a-secret'
+
+ALLOWED_HOSTS = [
+    'localhost',
+#    'example.com',
+#    'example.org',
+#    'example.net',
+]
+
+### Uncomment to enable social networks fields profile
+SOCIAL_NETWORK_ENABLED = True
+
+## Disable indexing
+ROBOTS_NOINDEX = True
+
+LOGGING = {
+    'version': 1,
+
+    'handlers': {
+        'null': {
+            'level': 'DEBUG',
+            'class': 'logging.NullHandler',
+        },
+    },
+
+    'loggers': {
+        'colab.mailman': {
+            'handlers': ['null'],
+            'propagate': False,
+        },
+        'haystack': {
+            'handlers': ['null'],
+            'propagate': False,
+        },
+    },
+}
+
+STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
@@ -0,0 +1,32 @@
+
+from django.utils.translation import ugettext_lazy as _
+from colab.plugins.utils.menu import colab_url_factory
+
+name = '{{ app_name }}'
+verbose_name = '{{ app_name_verbose }} Plugin'
+
+upstream = 'localhost'
+# middlewares = []
+
+urls = {
+    'include': '{{ app_name }}.urls',
+    'namespace': '{{ app_name }}',
+    'prefix': '^{{ app_name }}/',
+}
+
+menu_title = _('{{ app_name }}')
+
+url = colab_url_factory('{{ app_name }}')
+
+# Extra data to be exposed to plugin app config
+extra = {}
+
+menu_urls = (
+# Example of menu URL:
+#    url(display=_('Public Projects'), viewname='gitlab',
+#        kwargs={'path': 'public/projects'}, auth=False),
+
+# Example of authenticated user menu URL:
+#    url(display=_('Profile'), viewname='gitlab',
+#        kwargs={'path': 'profile'}, auth=True),
+)
@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+import os
+import sys
+
+import django
+from django.conf import settings
+from django.test.utils import get_runner
+
+
+def run():
+    os.environ['DJANGO_SETTINGS_MODULE'] = 'colab.settings'
+    os.environ['COLAB_PLUGINS'] = 'tests/plugins.d'
+    os.environ['COLAB_SETTINGS'] = 'tests/colab_settings.py'
+    django.setup()
+    TestRunner = get_runner(settings)
+    test_runner = TestRunner()
+    failures = test_runner.run_tests(["tests"])
+    sys.exit(bool(failures))
+
+
+if __name__ == "__main__":
+    run()
@@ -0,0 +1,11 @@
+
+from django.test import TestCase, Client
+
+
+class PluginTest(TestCase):
+
+    def setUp(self):
+        self.client = Client()
+
+    def test_true(self):
+        assert True
@@ -0,0 +1,25 @@
+
+import os
+
+import colab
+
+from django.core.management.commands.startapp import Command as StartAppCommand
+
+
+class Command(StartAppCommand):
+    help = ("Creates a Colab plugin directory structure for the given "
+            "plugin name in the current directory or optionally in the "
+            "plugin directory.")
+    missing_args_message = "You must provide a plugin name"
+
+    def handle_template(self, template, subdir):
+        if template is None:
+            return os.path.join(colab.__path__[0], 'conf', 'plugin_template')
+
+        return super(Command, self).handle_template(template, subdir)
+
+    def handle(self, name, **kwargs):
+        kwargs['app_name_dash'] = name.replace('_', '-')
+        kwargs['app_name_camel'] = name.title().replace('_', '')
+        kwargs['app_name_verbose'] = name.replace('_', ' ').title()
+        super(Command, self).handle(name, **kwargs)
...	...	@@ -0,0 +1,37 @@
	1	+#!/usr/bin/env python
	2	+"""
	3	+{{ app_name_verbose }} Colab plugin
	4	+===================================
	5	+"""
	6	+from setuptools import setup, find_packages
	7	+
	8	+install_requires = ['colab']
	9	+
	10	+tests_require = ['mock']
	11	+
	12	+
	13	+setup(
	14	+ name="{{ app_name_dash }}",
	15	+ version='0.1.0',
	16	+ author='<<Author Name>>',
	17	+ author_email='<<Author email>>',
	18	+ url='<< project url/repo url >>',
	19	+ description='{{ app_name_verbose }} Colab plugin',
	20	+ long_description=__doc__,
	21	+ license='<< project license >>',
	22	+ package_dir={'': 'src'},
	23	+ packages=find_packages('src'),
	24	+ zip_safe=False,
	25	+ install_requires=install_requires,
	26	+ test_suite="tests.runtests.run",
	27	+ tests_require=tests_require,
	28	+ extras_require={'test': tests_require},
	29	+ include_package_data=True,
	30	+ classifiers=[
	31	+ 'Framework :: Django',
	32	+ 'Intended Audience :: Developers',
	33	+ 'Intended Audience :: System Administrators',
	34	+ 'Operating System :: OS Independent',
	35	+ 'Topic :: Software Development'
	36	+ ],
	37	+)
...	...
...	...	@@ -0,0 +1,3 @@
	1	+
	2	+
	3	+default_app_config = '{{ app_name }}.apps.PluginAppConfig'
...	...
...	...	@@ -0,0 +1,8 @@
	1	+
	2	+from colab.plugins.utils.apps import ColabPluginAppConfig
	3	+
	4	+
	5	+class {{ app_name_camel }}AppConfig(ColabPluginAppConfig):
	6	+ name = '{{ app_name }}'
	7	+ verbose_name = '{{ app_name_verbose }} Plugin'
	8	+ short_name = '{{ app_name }}'
...	...
...	...	@@ -0,0 +1,9 @@
	1	+
	2	+from colab.plugins.data import PluginDataImporter
	3	+
	4	+
	5	+class {{ app_name_camel }}DataImporter(PluginDataImporter):
	6	+ app_label = '{{ app_name }}'
	7	+
	8	+ def fetch_data(self):
	9	+ pass
...	...
...	...	@@ -0,0 +1,6 @@
	1	+<rules
	2	+ xmlns="http://namespaces.plone.org/diazo"
	3	+ xmlns:css="http://namespaces.plone.org/diazo/css"
	4	+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
	5	+
	6	+</rules>
...	...
...	...	@@ -0,0 +1,2 @@
	1	+# Your search indexes here.
	2	+# See: http://django-haystack.readthedocs.org/en/latest/searchindex_api.html
...	...
...	...	@@ -0,0 +1,8 @@
	1	+
	2	+from django.conf.urls import patterns, url
	3	+
	4	+from .views import {{ app_name_camel }}ProxyView
	5	+
	6	+urlpatterns = patterns('',
	7	+ url(r'^(?P<path>.*)$', GitlabProxyView.as_view(), name='{{ app_name }}'),
	8	+)
...	...
...	...	@@ -0,0 +1,6 @@
	1	+
	2	+from colab.plugins.views import ColabProxyView
	3	+
	4	+
	5	+class {{ app_name_camel }}ProxyView(ColabProxyView):
	6	+ app_label = '{{ app_name }}'
...	...
...	...	@@ -0,0 +1,55 @@
	1	+
	2	+## Set to false in production
	3	+DEBUG = True
	4	+TEMPLATE_DEBUG = False
	5	+
	6	+## System admins
	7	+ADMINS = [['John Foo', 'john@example.com'], ['Mary Bar', 'mary@example.com']]
	8	+
	9	+MANAGERS = ADMINS
	10	+
	11	+COLAB_FROM_ADDRESS = '"Colab" <noreply@example.com>'
	12	+SERVER_EMAIL = '"Colab" <noreply@example.com>'
	13	+
	14	+EMAIL_HOST = 'localhost'
	15	+EMAIL_PORT = 25
	16	+EMAIL_SUBJECT_PREFIX = '[colab]'
	17	+
	18	+SECRET_KEY = 'not-a-secret'
	19	+
	20	+ALLOWED_HOSTS = [
	21	+ 'localhost',
	22	+# 'example.com',
	23	+# 'example.org',
	24	+# 'example.net',
	25	+]
	26	+
	27	+### Uncomment to enable social networks fields profile
	28	+SOCIAL_NETWORK_ENABLED = True
	29	+
	30	+## Disable indexing
	31	+ROBOTS_NOINDEX = True
	32	+
	33	+LOGGING = {
	34	+ 'version': 1,
	35	+
	36	+ 'handlers': {
	37	+ 'null': {
	38	+ 'level': 'DEBUG',
	39	+ 'class': 'logging.NullHandler',
	40	+ },
	41	+ },
	42	+
	43	+ 'loggers': {
	44	+ 'colab.mailman': {
	45	+ 'handlers': ['null'],
	46	+ 'propagate': False,
	47	+ },
	48	+ 'haystack': {
	49	+ 'handlers': ['null'],
	50	+ 'propagate': False,
	51	+ },
	52	+ },
	53	+}
	54	+
	55	+STATICFILES_STORAGE = 'django.contrib.staticfiles.storage.StaticFilesStorage'
...	...
...	...	@@ -0,0 +1,32 @@
	1	+
	2	+from django.utils.translation import ugettext_lazy as _
	3	+from colab.plugins.utils.menu import colab_url_factory
	4	+
	5	+name = '{{ app_name }}'
	6	+verbose_name = '{{ app_name_verbose }} Plugin'
	7	+
	8	+upstream = 'localhost'
	9	+# middlewares = []
	10	+
	11	+urls = {
	12	+ 'include': '{{ app_name }}.urls',
	13	+ 'namespace': '{{ app_name }}',
	14	+ 'prefix': '^{{ app_name }}/',
	15	+}
	16	+
	17	+menu_title = _('{{ app_name }}')
	18	+
	19	+url = colab_url_factory('{{ app_name }}')
	20	+
	21	+# Extra data to be exposed to plugin app config
	22	+extra = {}
	23	+
	24	+menu_urls = (
	25	+# Example of menu URL:
	26	+# url(display=_('Public Projects'), viewname='gitlab',
	27	+# kwargs={'path': 'public/projects'}, auth=False),
	28	+
	29	+# Example of authenticated user menu URL:
	30	+# url(display=_('Profile'), viewname='gitlab',
	31	+# kwargs={'path': 'profile'}, auth=True),
	32	+)
...	...