Metadata-Version: 2.1
Name: jupyter-cpp-kernel
Version: 1.0.0a6
Summary: C++ 14 kernel for Jupyter
Home-page: https://github.com/shiroinekotfs/jupyter-cpp-kernel
Download-URL: https://github.com/shiroinekotfs/jupyter-cpp-kernel/releases
Author: shiroinekotfs
Author-email: shiroineko.tfs@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/shiroinekotfs/jupyter-cpp-kernel/issues
Keywords: windows,macos,linux,jupyter,cpp,cpp14,jupyter-kernels,pip
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: C++
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

> :warning:
> * For C/C++ header add-on development, [try this template](https://github.com/shiroinekotfs/jupyter-cpp-header-template)
> * [Security issue with Jupyter Notebooks](https://github.com/shiroinekotfs/jupyter-cpp-kernel/discussions/20)

[![CodeQL](https://github.com/shiroinekotfs/jupyter-cpp-kernel/actions/workflows/codeql.yml/badge.svg)](https://github.com/shiroinekotfs/jupyter-cpp-kernel/actions/workflows/codeql.yml)

![GitHub repo size](https://img.shields.io/github/repo-size/shiroinekotfs/jupyter-cpp-kernel)
![GitHub Repo stars](https://img.shields.io/github/stars/shiroinekotfs/jupyter-cpp-kernel)
![PyPI - Downloads](https://img.shields.io/pypi/dm/jupyter-cpp-kernel?logo=pypi)

# C++ 14 kernel for Jupyter

## Installation

> :warning:
>
> If you want to use it on Windows, please installing the [GNU Compiler Collection for Windows](https://github.com/shiroinekotfs/jupyter-cpp-kernel/blob/master/INSTALL_ON_WINDOWS.md)

Normally, your target machine must meet these requirement packages before installing and using `jupyter-cpp-kernel`.

* `g++`
* `python3`, `python3-pip`
* `jupyter` (recommend `jupyterlab`)

### Install from PyPI

> :warning:
>
> For Windows User: Please follow [this instruction](https://github.com/shiroinekotfs/jupyter-cpp-kernel/blob/master/INSTALL_ON_WINDOWS.md) to install GCC properly.

```shell
pip install jupyter-cpp-kernel
```

### Install from GitHub repo


> :warning:
>
> For Windows User: Please follow [this instruction](https://github.com/shiroinekotfs/jupyter-cpp-kernel/blob/master/INSTALL_ON_WINDOWS.md) to install GCC properly.

```shell
pip install git+https://github.com/shiroinekotfs/jupyter-cpp-kernel.git
```

## Contributing

You can clone, create a fork or import this repo whenever you want.

Please follow the GitHub standards and the license

## Guides (notebook)

<p align="center">
    <b>See more at </b><a href="https://github.com/shiroinekotfs/jupyter-cpp-kernel-doc">here</a>
    <br><br>
    <img src="https://github.com/shiroinekotfs/jupyter-cpp-kernel/assets/115929530/201d3f51-fa4c-44d4-bc2b-4ea2a252f13c" />
</p>
