Move cli to submodule and added sirbot init (#27)

`sirbot init` will prompt the user for and auto generate a
configuration file and an empty plugin

Author: ovv

docs/configuration.rst

@@ -2,6 +2,14 @@
 Configuration
 =============
 
+.. note::
+
+    A configuration file and an empty plugin can be auto-generated using:
+
+    .. code-block:: console
+
+        $ sirbot init
+
 Start
 -----
 
@@ -16,19 +24,10 @@ To start Sir Bot-a-lot you can use one of:
     $ python run.py
 
 
-Environment variables
----------------------
-
-The environment variable take precedence over the command line arguments.
-
-* :code:`SIRBOT_PORT`: Port where to run Sir Bot-a-lot
-* :code:`SIRBOT_CONFIG`: Path to Sir Bot-a-lot Yaml config file
-
-
 Command line arguments
 ----------------------
 
-The command line arguments take precedence over the configuration file.
+The command line arguments take precedence over the environment variables.
 
 * :code:`-h --help`: Help message
 * :code:`-P --port`: Port where to run Sir Bot-a-lot
@@ -37,6 +36,15 @@ The command line arguments take precedence over the configuration file.
 * :code:`-p --plugins`: Plugins to start
 
 
+Environment variables
+---------------------
+
+The environment variable take precedence over the configuration file.
+
+* :code:`SIRBOT_PORT`: Port where to run Sir Bot-a-lot
+* :code:`SIRBOT_CONFIG`: Path to Sir Bot-a-lot Yaml config file
+
+
 Configuration file
 ------------------
 

docs/quickstart.rst

@@ -40,8 +40,13 @@ The default configuration file look like this:
         port: 8080
         plugins: []
     
-Plugins can also be added with the :code:`--plugins` argument
+Plugins can also be added with the :code:`--plugins` argument.
 
+You can auto-generate a configuration file and a basic plugin with:
+
+.. code-block:: console
+
+    $ sirbot init
 
 Start
 -----

requirements/requirements.in

@@ -5,3 +5,4 @@ multidict
 pluggy
 pyyaml
 yarl
+mako

requirements/requirements.txt

@@ -4,10 +4,12 @@
 #
 #    pip-compile --output-file requirements/requirements.txt requirements/requirements.in
 #
-aiohttp==2.0.7
+aiohttp==2.2.3
 async-timeout==1.2.1
-chardet==3.0.2
-multidict==2.1.4
+chardet==3.0.4
+mako==1.0.6
+markupsafe==1.0           # via mako
+multidict==3.1.0
 pluggy==0.4.0
 pyyaml==3.12
-yarl==0.10.1
+yarl==0.11.0

requirements/requirements_dev.txt

@@ -4,43 +4,47 @@
 #
 #    pip-compile --output-file requirements/requirements_dev.txt requirements/requirements_dev.in
 #
-aiohttp==2.0.7            # via pytest-aiohttp
+aiohttp==2.2.3            # via pytest-aiohttp
 alabaster==0.7.10         # via sphinx
 async-timeout==1.2.1      # via aiohttp
 babel==2.4.0              # via sphinx
-chardet==3.0.2            # via aiohttp
+certifi==2017.4.17        # via requests
+chardet==3.0.4            # via aiohttp, requests
 click==6.7                # via pip-tools
 commonmark==0.5.4         # via recommonmark
-coverage==4.3.4
+coverage==4.4.1
 docutils==0.13.1          # via recommonmark, sphinx
 first==2.0.1              # via pip-tools
 flake8==3.3.0
+idna==2.5                 # via requests
 imagesize==0.7.1          # via sphinx
 jinja2==2.9.6             # via sphinx
 markupsafe==1.0           # via jinja2
 mccabe==0.6.1             # via flake8
-multidict==2.1.4          # via aiohttp, yarl
+multidict==3.1.0          # via aiohttp, yarl
 pip-tools==1.9.0
 pluggy==0.4.0             # via tox
 pockets==0.5.1            # via sphinxcontrib-napoleon
-py==1.4.33                # via pytest, tox
+py==1.4.34                # via pytest, tox
 pycodestyle==2.3.1        # via flake8
 pyflakes==1.5.0           # via flake8
 pygments==2.2.0           # via sphinx
 pytest-aiohttp==0.1.3
-pytest-asyncio==0.5.0
-pytest-cov==2.4.0
+pytest-asyncio==0.6.0
+pytest-cov==2.5.1
 pytest-runner==2.11.1
-pytest==3.0.7             # via pytest-aiohttp, pytest-asyncio, pytest-cov
+pytest==3.1.3             # via pytest-aiohttp, pytest-asyncio, pytest-cov
 pytz==2017.2              # via babel
 recommonmark==0.4.0
-requests==2.13.0          # via sphinx
+requests==2.18.1          # via sphinx
 six==1.10.0               # via pip-tools, pockets, sphinx, sphinxcontrib-napoleon
 snowballstemmer==1.2.1    # via sphinx
 sphinx-pypi-upload==0.2.1
-sphinx==1.5.5
+sphinx==1.6.3
 sphinxcontrib-asyncio==0.2.0
 sphinxcontrib-napoleon==0.6.1
+sphinxcontrib-websupport==1.0.1  # via sphinx
 tox==2.7.0
+urllib3==1.21.1           # via requests
 virtualenv==15.1.0        # via tox
-yarl==0.10.1              # via aiohttp
+yarl==0.11.0              # via aiohttp

run.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-from sirbot.core.cli import main
+from sirbot.cli import main
 
 if __name__ == '__main__':
     main()

setup.py

@@ -64,14 +64,17 @@ def parse_readme():
         'sirbot',
         'sirbot.core',
         'sirbot.utils',
+        'sirbot.cli',
     ],
     package_dir={
         'sirbot': 'sirbot',
         'sirbot.core': 'sirbot/core',
         'sirbot.utils': 'sirbot/utils',
+        'sirbot.cli': 'sirbot/cli',
     },
     package_data={
         'sirbot.core': ['config.yml'],
+        'sirbot.cli': ['sirbot.yml.mako', 'plugin.py.mako']
     },
     # To provide executable scripts, use entry points in preference to the
     # "scripts" keyword. Entry points provide cross-platform support and
@@ -86,7 +89,7 @@ def parse_readme():
     # installed, specify them here.
     entry_points={
         'console_scripts': [
-            'sirbot=sirbot.core.cli:main'
+            'sirbot=sirbot.cli:main'
         ]
     },
     include_package_data=True,

sirbot/cli/__init__.py

@@ -0,0 +1 @@
+from .cli import main  # noQa

sirbot/cli/cli.py

@@ -0,0 +1,75 @@
+import argparse
+import asyncio
+import logging
+import sys
+
+from . import config, initialize
+from ..core import SirBot
+
+
+def parse_args(arguments):
+    parser = argparse.ArgumentParser(description='The good Sir Bot-a-lot')
+    parser.add_argument('-P', '--port', dest='port', action='store',
+                        type=int,
+                        help='port')
+    parser.add_argument('-c', '--config', action='store',
+                        help='config file path')
+    parser.add_argument('-u', '--update', help='Update plugins',
+                        action='store_true', dest='update')
+    parser.add_argument('-p', '--plugins', help='Plugins to load',
+                        dest='plugins', nargs='+')
+
+    subparsers = parser.add_subparsers(help='Additional commands',
+                                       dest='subcommands')
+
+    init_parser = subparsers.add_parser('init',
+                                        help='Initialize your Sir Bot-a-lot'
+                                             ' configuration')
+    init_parser.set_defaults(func=initialize.initialize_plugin)
+    init_parser.add_argument('-n', '--name', action='store',
+                             help='configuration plugin name')
+    init_parser.add_argument('-p', '--plugins', help='Plugins to load',
+                             dest='plugins', nargs='+')
+    init_parser.add_argument('-P', '--port', dest='port', action='store',
+                             type=int, help='port')
+    init_parser.add_argument('-l', '--log', dest='log_level', action='store',
+                             choices=['DEBUG', 'INFO', 'WARNING', 'ERROR'],
+                             help='Logging level', default='INFO')
+
+    return parser.parse_args(arguments)
+
+
+def main():  # pragma: no cover
+    args = parse_args(sys.argv[1:])
+    logging.basicConfig()
+
+    if args.subcommands:
+        args.func(args)
+    else:
+        configuration = config.load_config(args)
+        if args.update:
+            update(configuration)
+        else:
+            start(configuration)
+
+
+def start(configuration, loop=None):  # pragma: no cover
+    if not loop:
+        loop = asyncio.get_event_loop()
+
+    bot = SirBot(config=configuration, loop=loop)
+    bot.run(port=int(configuration['sirbot']['port']))
+    return bot
+
+
+def update(configuration, loop=None):
+    if not loop:
+        loop = asyncio.get_event_loop()
+
+    bot = SirBot(config=configuration, loop=loop)
+    loop.run_until_complete(bot.update())
+    return bot
+
+
+if __name__ == '__main__':
+    main()  # pragma: no cover

sirbot/cli/config.py

@@ -0,0 +1,35 @@
+import os
+import yaml
+
+
+def load_config(args):
+
+    path = args.config or os.getenv('SIRBOT_CONFIG')
+    port = args.port or os.getenv('SIRBOT_PORT')
+    config = load_file(path)
+
+    if 'sirbot' not in config:
+        config['sirbot'] = dict()
+
+    if args.plugins:
+        if 'plugins' not in config['sirbot']:
+            config['sirbot']['plugins'] = list()
+        config['sirbot']['plugins'].extend(args.plugins)
+
+    if port:
+        config['sirbot']['port'] = port
+    elif 'port' not in config['sirbot']:
+        config['sirbot']['port'] = 8080
+
+    return config
+
+
+def load_file(path=None):
+
+    if not path:
+        return dict()
+    if not os.path.isabs(path):
+        path = os.path.join(os.getcwd(), path)
+
+    with open(path) as file:
+        return yaml.load(file)

sirbot/cli/initialize.py

@@ -0,0 +1,77 @@
+import os
+
+from mako.template import Template
+
+
+def initialize_plugin(args):
+    try:
+        config = make_config(args)
+        generate_yaml(config)
+        generate_python(config)
+    except KeyboardInterrupt:
+        pass
+
+
+def make_config(args):
+    config = {
+        'name': args.name,
+        'plugins': args.plugins,
+        'port': args.port,
+        'log_level': args.log_level
+    }
+
+    if not config['name']:
+        while True:
+            name = input('Configuration plugin name: ')
+            if len(name) > 0:
+                break
+        config['name'] = name.lower().replace(' ', '_').strip()
+
+    if not config['plugins']:
+        plugins = input('Plugins to load (comma separated list): ')
+
+        if plugins:
+            config['plugins'] = set(
+                plugin.strip() for plugin in plugins.split(',')
+            )
+        else:
+            print('No plugins will be configured')
+    else:
+        config['plugins'] = set(config['plugins'])
+    config['plugins'].add(config['name'])
+
+    if not config['port']:
+        while True:
+            try:
+                port = int(input('Sir Bot-a-lot port: '))
+            except ValueError:
+                print('Please enter an integer')
+            else:
+                config['port'] = port
+                break
+
+    return config
+
+
+def generate_yaml(config):
+    path = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)), 'sirbot.yml.mako'
+    )
+
+    config_template = Template(filename=path)
+    config_render = config_template.render(**config)
+
+    with open('sirbot.yml', 'w') as file:
+        file.write(config_render)
+
+
+def generate_python(config):
+    path = os.path.join(
+        os.path.dirname(os.path.abspath(__file__)), 'plugin.py.mako'
+    )
+
+    plugin_template = Template(filename=path)
+    plugin_render = plugin_template.render(**config)
+
+    with open('{}.py'.format(config['name']), 'w') as file:
+        file.write(plugin_render)