Metadata-Version: 2.0
Name: Flask-CLI
Version: 0.4.0
Summary: Backport of Flask 1.0 new click integration.
Home-page: http://github.com/inveniosoftware/flask-cli/
Author: Invenio Collaboration
Author-email: info@invenio-software.org
License: BSD
Platform: any
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Utilities
Classifier: Development Status :: 5 - Production/Stable
Requires-Dist: Flask (>=0.10)
Requires-Dist: click (>=2.0)
Provides-Extra: all
Requires-Dist: Sphinx (>=1.3); extra == 'all'
Requires-Dist: check-manifest (>=0.25); extra == 'all'
Requires-Dist: coverage (>=4.0); extra == 'all'
Requires-Dist: isort (>=4.2.2); extra == 'all'
Requires-Dist: pydocstyle (>=1.0.0); extra == 'all'
Requires-Dist: pytest-cache (>=1.0); extra == 'all'
Requires-Dist: pytest-cov (>=1.8.0); extra == 'all'
Requires-Dist: pytest-pep8 (>=1.0.6); extra == 'all'
Requires-Dist: pytest (>=2.8.0); extra == 'all'
Requires-Dist: Sphinx (>=1.3); extra == 'all'
Requires-Dist: check-manifest (>=0.25); extra == 'all'
Requires-Dist: coverage (>=4.0); extra == 'all'
Requires-Dist: isort (>=4.2.2); extra == 'all'
Requires-Dist: pydocstyle (>=1.0.0); extra == 'all'
Requires-Dist: pytest-cache (>=1.0); extra == 'all'
Requires-Dist: pytest-cov (>=1.8.0); extra == 'all'
Requires-Dist: pytest-pep8 (>=1.0.6); extra == 'all'
Requires-Dist: pytest (>=2.8.0); extra == 'all'
Provides-Extra: docs
Requires-Dist: Sphinx (>=1.3); extra == 'docs'
Provides-Extra: tests
Requires-Dist: check-manifest (>=0.25); extra == 'tests'
Requires-Dist: coverage (>=4.0); extra == 'tests'
Requires-Dist: isort (>=4.2.2); extra == 'tests'
Requires-Dist: pydocstyle (>=1.0.0); extra == 'tests'
Requires-Dist: pytest-cache (>=1.0); extra == 'tests'
Requires-Dist: pytest-cov (>=1.8.0); extra == 'tests'
Requires-Dist: pytest-pep8 (>=1.0.6); extra == 'tests'
Requires-Dist: pytest (>=2.8.0); extra == 'tests'

===========
 Flask-CLI
===========

About
=====

Flask-CLI is a backport of Flask 1.0 new click integration to Flask 0.10. Do not install this package if you use Flask 1.0+.

Installation
============

Flask-CLI is on PyPI so all you need is: ::

    pip install flask-cli


Usage
=====

Initialize the extension like this:

.. code-block:: python

   from flask import Flask
   from flask_cli import FlaskCLI
   app = Flask('myapp')
   FlaskCLI(app)

   @app.cli.command()
   def mycmd():
       click.echo("Test")

   @app.shell_context_processor
   def myctx():
       return {'myvar': 'value'}

Import from this library instead of ``flask.cli``:

.. code-block:: python

   from flask_cli import FlaskGroup

Documentation
=============

Documentation is readable at http://flask-cli.readthedocs.org or can be
build using Sphinx: ::

    pip install Sphinx
    python setup.py build_sphinx

Testing
=======

Running the test suite is as simple as: ::

    python setup.py test


