Skip to main content

Replace default `flask shell` command by similar command running IPython.

Project description

Flask-Shell-IPython

flask-shell-ipython is a Python package that replaces the default flask shell command with a similar command that runs IPython. This provides an enhanced interactive Python shell with additional features like syntax highlighting, tab-completion, and more.

Installation

To install flask-shell-ipython, simply run:

pip install flask-shell-ipython

Usage

After installing flask-shell-ipython, the flask shell command will automatically use IPython instead of the default Python shell. There are no additional steps required.

flask shell

You can also pass any valid IPython arguments after the flask shell command:

flask shell --no-banner -i foo.py

Configuration

You can configure IPython settings by adding an IPYTHON_CONFIG key to your Flask app's configuration. The value should be a dictionary containing the configuration options you'd like to set.

For example:

app.config['IPYTHON_CONFIG'] = {
    'InteractiveShell': {
        'colors': 'Linux',
        'confirm_exit': False,
    },
}

Testing

To run tests for flask-shell-ipython, install the pytest-forked plugin, which enables running tests in isolated forked subprocesses to ensure running a clean IPython instance for each test case.

Installing Dependencies

Install testing dependencies from requirements-test.txt:

pip install -r requirements-test.txt

Running Tests

After installing the dependencies, run the test suite with the --forked option:

pytest --forked

Please, note that does pytest-forked does not work on Windows. To test flask-shell-ipython on Windows run each test manually.

License

flask-shell-ipython is licensed under the MIT License. See the LICENSE file for more information.

Contributing

If you'd like to contribute to the project, feel free to submit a pull request on the GitHub repository at http://github.com/ei-grad/flask-shell-ipython.

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_shell_ipython-0.5.3.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

flask_shell_ipython-0.5.3-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file flask_shell_ipython-0.5.3.tar.gz.

File metadata

  • Download URL: flask_shell_ipython-0.5.3.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for flask_shell_ipython-0.5.3.tar.gz
Algorithm Hash digest
SHA256 1a8bb90da18c34d15bc4ad817820101fffa93507a7eb685532ed518aea280848
MD5 4c462eefb5152e38900aff357911c9eb
BLAKE2b-256 1485cd1341451be9f34a5ab8895b596ca606aef6ce643452d47148c17d4a96a9

See more details on using hashes here.

File details

Details for the file flask_shell_ipython-0.5.3-py3-none-any.whl.

File metadata

File hashes

Hashes for flask_shell_ipython-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c0a1905671ba7223d36e59854e7900832a0febf127e5c01793377af878560ebd
MD5 1be7d4f691f9c3f9c5e5275ce10befdd
BLAKE2b-256 15e05e8480206303e4bd7340d74fce4be21340a762ba1f7ce2c6219def66eff2

See more details on using hashes here.

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