Metadata-Version: 2.4
Name: gnuplot_kernel
Version: 0.5.0
Summary: A gnuplot kernel for Jupyter
Author-email: Hassan Kibirige <has2k1@gmail.com>
License: Copyright (c) 2016, Hassan Kibirige 
        All rights reserved. 
        
        Redistribution and use in source and binary forms, with or without 
        modification, are permitted provided that the following conditions are met: 
        
         * Redistributions of source code must retain the above copyright notice, 
           this list of conditions and the following disclaimer. 
         * Redistributions in binary form must reproduce the above copyright 
           notice, this list of conditions and the following disclaimer in the 
           documentation and/or other materials provided with the distribution. 
         * Neither the name of  nor the names of its contributors may be used to 
           endorse or promote products derived from this software without specific 
           prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
        ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
        LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
        CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
        POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: homepage, https://github.com/has2k1/gnuplot_kernel
Project-URL: repository, https://github.com/has2k1/gnuplot_kernel
Project-URL: ci, https://github.com/has2k1/gnuplot_kernel/actions
Classifier: Framework :: IPython
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: System :: Shells
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: metakernel>=0.30.0
Requires-Dist: jupyter>=1.1.1
Provides-Extra: dev
Requires-Dist: gnuplot_kernel[test]; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: matplotlib>=3.8.0; extra == "dev"
Requires-Dist: pyright>=1.1.405; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest-cov>=4.0.0; extra == "test"
Dynamic: license-file

# A Jupyter/IPython kernel for Gnuplot

[![Release](https://img.shields.io/pypi/v/gnuplot_kernel.svg)](https://pypi.python.org/pypi/gnuplot_kernel)
[![License](https://img.shields.io/pypi/l/gnuplot_kernel.svg)](https://pypi.python.org/pypi/gnuplot_kernel)
[![Build Status](https://github.com/has2k1/gnuplot_kernel/actions/workflows/testing.yml/badge.svg)](https://github.com/has2k1/gnuplot_kernel/actions/workflows/testing.yml)
[![Coverage](https://codecov.io/github/has2k1/gnuplot_kernel/branch/main/graph/badge.svg)](https://codecov.io/github/has2k1/gnuplot_kernel)

`gnuplot_kernel` has been developed for use specifically with `Jupyter Notebook`.
It can also be loaded as an `IPython` extension allowing for `gnuplot` code in the same `notebook`
as `python` code.

## Installation

It is good practice to install `gnuplot_kernel` in a virtual environment.
We recommend using [uv](https://docs.astral.sh/uv/getting-started/installation/) or
[python venv](https://docs.python.org/3/library/venv.html).

### Option 1: Using `uv`

```console
$ uv venv
```

**Official release**

```console
$ uv pip install gnuplot_kernel
$ uv run python -m gnuplot_kernel install --user
```

The last command installs a kernel spec file for the current python installation. This
is the file that allows you to choose a jupyter kernel in a notebook.

**Development version**


```console
$ uv pip install git+https://github.com/has2k1/gnuplot_kernel.git@master
$ uv run python -m gnuplot_kernel install --user
```

### Option 2: Using `python venv`

```console
$ python3 -m venv .venv && source .venv/bin/activate
```

**Official release**

```console
$ pip install gnuplot_kernel
$ python -m gnuplot_kernel install --user
```

**Development version**

```console
$ pip install git+https://github.com/has2k1/gnuplot_kernel.git@master
$ python -m gnuplot_kernel install --user
```

## Requires

- System installation of [Gnuplot](http://www.gnuplot.info/)

## Documentation

1. [Example Notebooks](https://github.com/has2k1/gnuplot_kernel/tree/main/examples) for `gnuplot_kernel`.
2. [Metakernel magics](https://github.com/Calysto/metakernel/blob/master/metakernel/magics/README.md), these are available when using `gnuplot_kernel`.
