Skip to main content

Backport of Flask 1.0 new click integration.

Project description

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:

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:

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-CLI-0.3.0.tar.gz (21.0 kB view hashes)

Uploaded Source

Built Distribution

Flask_CLI-0.3.0-py2.py3-none-any.whl (13.1 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page