/flask-moreshell

Flask shell with IPython, BPython, PTPython! 🌈

Primary LanguagePythonMIT LicenseMIT

Flask Moreshell

flask shell with IPython, BPython, PTPython!

PyPI Status Python Version License

Read the documentation at https://flask-moreshell.readthedocs.io/ Tests Codecov

pre-commit Black

Features

This package provides functionality to allow flask shell commands to be used with the ipython, bpython, and ptpython shells.

Requirements

  • Python 3.9+
  • Flask 2.3+

Installation

You can install Flask Moreshell via pip from PyPI:

$ pip install flask-moreshell

or anything else that can install packages from PyPI. for example, poetry or pipenv.

Usage

after the package is installed, you can use the flask shell command as usual.

$ flask shell

and you can see python REPLs like this, with flask app loaded.

shell_usage

By default, make sure that ipython, bpython, and ptpython are installed in your current virtual environment. When you use the flask shell command, the package will look for and load the Python REPLs in that order.

if you want to use a specific shell, you can use the --shelltype option.

see Usage for more information.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, Flask Moreshell is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.