Skip to main content

An arctic, north-bluish theme for the IPython interactive prompt.

Project description

ipython-nord-theme

An arctic, north-bluish theme for the IPython interactive prompt.

Quickstart

To easily get the theme installed and loading at startup:

pip install ipython_nord_theme[hook]

Installation

Install using pip:

pip install ipython-nord-theme 

or with conda:

conda install -c lewisacidic ipython-nord-theme

Usage

Load the theme with IPython magic:

%load_ext ipython_nord_theme

To set the theme back to what you had previously:

%unload_ext ipython_nord_theme

Running this at startup

You can either put the following snippet in your IPython startup directory (usually $HOME/.ipython/profile_default/startup):

try:
    from ipython_nord_theme.startup import load
    load()
    del load  # don't pollute global namespace!!
except ModuleNotFoundError:
    pass

Or use ipython-startup-hook (recommended if you use IPython within virtual environments).

This may be done at install with the command given in the Quickstart.

Development

Create the conda environment:

conda env create -f envs/dev.yml
conda activate ipython-nord-theme-dev

Format code by running the pre-commit tasks:

pre-commit run --all

Run the tests with pytest (note we need to use ipython rather than python for these tests):

ipython -m pytest

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

ipython-nord-theme-0.1.0.tar.gz (28.4 kB view hashes)

Uploaded Source

Built Distribution

ipython_nord_theme-0.1.0-py3-none-any.whl (6.1 kB view hashes)

Uploaded 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