Metadata-Version: 2.1
Name: flask-konch
Version: 2.0.0
Summary: An improved shell command for the Flask CLI
Home-page: https://github.com/sloria/flask-konch
Author: Steven Loria
Author-email: sloria1@gmail.com
License: MIT
Description: ***********
        Flask-Konch
        ***********
        
        |pypi-package| |build-status| |black|
        
        .. image:: https://user-images.githubusercontent.com/2379650/32085344-61a939da-ba9c-11e7-84e2-39fbd9eadc9d.png
            :alt: Flask-Konch
        
        An improved shell command for Flask
        ===================================
        
        Flask-Konch adds an improved shell command, ``flask konch``, to the `Flask CLI <http://flask.pocoo.org/docs/0.11/cli/>`_.
        
        
        Benefits of ``flask konch`` over ``flask shell``
        ================================================
        
        - Uses IPython, BPython, or ptpython if available, and falls back to built-in interpreter
        - Automatically imports top-level Flask functions and classes by default
        - Define additional variables to include in the shell context
        - Configurable banner and prompt
        
        Flask-Konch uses `konch <https://github.com/sloria/konch>`_, a shell configuration utility, under the hood.
        
        Get it now
        ==========
        ::
        
            pip install flask-konch
        
        Usage
        =====
        
        To run the shell:
        
        .. code-block:: bash
        
           export FLASK_APP=path/to/app.py
           flask konch
        
        To add additional variables to the shell context:
        
        .. code-block:: python
        
           app = Flask(__name__)
           app.config.update({"KONCH_CONTEXT": {"db": database, "User": User}})
        
        
        Configuration options
        =====================
        
        - ``KONCH_FLASK_IMPORTS``: Whether to automatically import top-level Flask functions and classes. Defaults to ``True``.
        - ``KONCH_FLASK_SHELL_CONTEXT``: Whether to automatically import Flask shell context, as registered by `shell_context_processor(f) <http://flask.pocoo.org/docs/0.12/api/#flask.Flask.shell_context_processor>`_. Defaults to ``True``.
        - ``KONCH_CONTEXT``: Dictionary of additional variables to include in the shell context.
        - ``KONCH_SHELL``: May be ``'ipy'``, ``'bpy'``, ``'ptpy'``, ``'ptipy'``, ``'py'``, or ``'auto'`` (default).
        - ``KONCH_BANNER``: Custom banner.
        - ``KONCH_PROMPT``: Custom input prompt.
        - ``KONCH_OUTPUT``: Custom output prompt.
        - ``KONCH_CONTEXT_FORMAT``: Format to display shell context. May be ``'full'``, ``'short'``, or a function that receives the context dictionary as input and returns a string.
        - ``KONCH_IPY_AUTORELOAD``: Whether to load and enable the IPython autoreload extension (must be using ``ipython`` shell).
        - ``KONCH_IPY_EXTENSIONS``: List of IPython extension names to load (must be using ``ipython`` shell).
        - ``KONCH_IPY_COLORS``: IPython color style.
        - ``KONCH_IPY_HIGHLIGHTING_STYLE``: IPython code highlighting style.
        - ``KONCH_PTPY_VI_MODE``: Enable vi mode (must be using ``ptpython`` shell).
        
        License
        =======
        
        MIT licensed. See the bundled `LICENSE <https://github.com/sloria/flask-konch/blob/master/LICENSE>`_ file for more details.
        
        .. |pypi-package| image:: https://badgen.net/pypi/v/flask-konch
            :target: http://badge.fury.io/py/flask-konch
            :alt: Latest PyPI version
        .. |build-status| image:: https://badgen.net/travis/sloria/flask-konch/master
            :target: https://travis-ci.org/sloria/flask-konch
            :alt: Travis-CI
        .. |black| image:: https://badgen.net/badge/code%20style/black/000
            :target: https://github.com/ambv/black
            :alt: Code style: Black
        
Keywords: flask-konch
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: System :: Shells
Provides-Extra: lint
Provides-Extra: dev
Provides-Extra: tests
