Metadata-Version: 2.1
Name: ezkernel
Version: 0.1.0
Summary: A simple CLI wrapper to manage Jupyter kernels
License: MIT
Author: Ali Tavallaie
Author-email: a.tavallaie@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: ipykernel (>=6.29.3,<7.0.0)
Requires-Dist: jupyter-core (>=5.7.1,<6.0.0)
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Project-URL: Documentation, https://github.com/tavallaie/ezkernel
Project-URL: Homepage, https://github.com/tavallaie/ezkernel
Project-URL: Repository, https://github.com/tavallaie/ezkernel
Description-Content-Type: text/x-rst

================
 ezkernel
================

ezkernel is a Python library for managing Jupyter kernels. With ezkernel, you can easily add, remove, and rename Jupyter kernels directly from the command line.

Installation
============

To install ezkernel, simply run this command in your terminal:

.. code-block:: bash

    pip install ezkernel

Features
========

- Add new Jupyter kernels
- Remove existing Jupyter kernels
- Rename Jupyter kernels

Usage
=====

Adding a Kernel
---------------

To add a new Jupyter kernel, use the following command:

.. code-block:: bash

    ezkernel add <kernel-name> --display-name "Display Name"

Removing a Kernel
-----------------

To remove an existing Jupyter kernel, use:

.. code-block:: bash

    ezkernel remove <kernel-name>

Renaming a Kernel
-----------------

To rename an existing Jupyter kernel, use:

.. code-block:: bash

    ezkernel rename <old-kernel-name> <new-kernel-name>

Contributing
============

Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.

License
=======

`MIT <https://choosealicense.com/licenses/mit/>`_

