An improved shell command for the Flask CLI
Project description
An improved shell command for Flask
Flask-Konch adds an improved shell command, flask konch, to the Flask 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, a shell configuration utility, under the hood.
Get it now
pip install flask-konch
Usage
To run the shell:
export FLASK_APP=path/to/app.py
flask konch
To add additional variables to the shell context:
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). 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 file for more details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file flask-konch-3.0.0.tar.gz
.
File metadata
- Download URL: flask-konch-3.0.0.tar.gz
- Upload date:
- Size: 6.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8cbf06e6cf8728e69e44851d8acae135777c7914df4e2a566d1b8d27cba4ef00 |
|
MD5 | 9643eae13c11c7971a3ff33ccddbc450 |
|
BLAKE2b-256 | 7f35d1b60873174944277240c880771a5b26ff855def8ea1eceb78d07a4aa84c |
File details
Details for the file flask_konch-3.0.0-py3-none-any.whl
.
File metadata
- Download URL: flask_konch-3.0.0-py3-none-any.whl
- Upload date:
- Size: 5.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.12
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5bb6ebf19b625700406a5bbd0a4d3fa6026f1c080129c6266ebfd99e926da8f3 |
|
MD5 | 238f5eb2bc97adcdbe7411eadeb71a02 |
|
BLAKE2b-256 | d82de4e968fe7e4de5166bc3c8bc49501bc1368886c266d706dc45e2ec183eec |