https://github.com/jupyter-xeus/xeus-cookiecutter
Cookiecutter for xeus-based Jupyter kernels
https://github.com/jupyter-xeus/xeus-cookiecutter
Last synced: 4 months ago
JSON representation
Cookiecutter for xeus-based Jupyter kernels
- Host: GitHub
- URL: https://github.com/jupyter-xeus/xeus-cookiecutter
- Owner: jupyter-xeus
- License: mit
- Created: 2021-09-11T12:18:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T06:40:16.000Z (11 months ago)
- Last Synced: 2025-02-06T02:27:17.872Z (5 months ago)
- Language: CMake
- Homepage:
- Size: 4.16 MB
- Stars: 5
- Watchers: 4
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
=================================================
xeus-cookiecutter
=================================================
.. image:: docs/xeus-cookiecutter.svg
:scale: 150 %
.. image:: https://github.com/jupyter-xeus/xeus-cookiecutter/actions/workflows/main.yml/badge.svg
:target: https://github.com/jupyter-xeus/xeus-cookiecutter/actions/workflows/main.yml
.. image:: https://github.com/jupyter-xeus/xeus-cookiecutter/actions/workflows/main.yml/badge.svg?branch=rendered
:target: https://github.com/jupyter-xeus/xeus-cookiecutter/actions/workflows/main.yml
.. image:: https://readthedocs.org/projects/xeus-cookiecutter/badge/?version=latest
:target: http://xeus-cookiecutter.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
Overview
--------
This cookiecutter can be used to generate `xeus-based `_ `Jupyter kernels `_.
This cookiecutter has been used to generate `xeus-lua `_ and `xeus-wren `_.
Features
--------
* Unit Tests:
* Kernel is tested via `jupyter-kernel-tests `_.
* Continuous Integration with Github Actions:
* Tests run on ubuntu, mac, win and emscripten
* Fast installation of dependencies via `micromamba `_
* Documentation:
* Ready to use `sphinx-based `_ included.
* Compatible to run on `readthedocs `_.
* Modern CMake
* WASM build:
* Includes a wasm target which can be used to build a `jupyterlite-kernel `_ for your kernel similar to `jupyterlite xeus-lua `_.
Usage
-----
Install the cookiecutter package with conda
.. code-block:: bash
conda install cookiecutter -c conda-forge
or pip
.. code-block:: bash
python -m pip install cookiecutter
Once cookiecutter is available on your system, run the xeus-cookiecutter:
.. code-block:: bash
cookiecutter https://github.com/jupyter-xeus/xeus-cookiecutter
.. image:: docs/term/usage.gif
:width: 800
:alt: Alternative text
Conda-Forge
-----------
To release your kernel on `conda-forge `_, you create a conda forge recipe. Examples for conda forge recipes for xeus-based kernels can be found here.
* https://github.com/conda-forge/xeus-lua-feedstock/
* https://github.com/conda-forge/xeus-wren-feedstock/
* https://github.com/conda-forge/xeus-python-feedstock/
Cookiecutter Variables Explanation
----------------------------------
.. list-table:: Variables
:header-rows: 1
* - Variables Name
- Default Value
- Meaning
* - full_name
- John Doe
- Name of the author. Used in copyright sections.
* - email
- [email protected]
- Email of the author.
* - github_user_name
- JohnDoe
- Github user / organization name
* - language
- mylang
- name of your language. Ie "lua", "R", "python", etc.
* - language_mimetype
- text/x-mylangrc
- Mimetype of the programing language. Used in the `kernel.json` file.
* - language_file_extension
- mylang
- File extension of the programing language. Used in the `kernel.json` file.
* - language_version
- 1.0.0
- Version of the language. Used in the `kernel.json` file.
* - with_wasm
- no
- Include code to build your kernel for wasm with emscripten. Not every kernel / language can be compiled to wasm code.
* - with_debugger
- no
- Include code for the debugger to support the debugger protocol. This is only a placeholder for future releases. Atm this option is only used in the `kernel.json` file.
* - project_name
- xeus-mylang
- The name of the project. This is used everywhere.
* - kernel_name
- xmylang
- The name of the kernel itself.
* - package_name
- xeus-mylang
- The name of the package.
* - library_name
- xeus-mylang
- The name of the shared/static library.
* - binary_name
- xmylang
- Name of ther binary.
* - conda_package_name
- xeus-mylang
- The name of the conda package for this package. This is used in the `environment.yml` which is used for `mybinder `_ support. This only becomes useful once the package is released on conda-forge (this has to be done by hand).
* - cmake_package_name
- xeus-mylang
- Name of the cmake package
* - readthedocs_package_name
- xeus-mylang
- Name of the package on `readthedocs `_. (The package has to be activated on readthedocs by hand).
* - github_project_name
- xeus-mylang
- The name of the root folder / the name of the project on `github `_
* - branch_name
- main
- The default branch name
* - cpp_root_folder
- xeus-mylang
- The name of the C++ root include folder.
* - config_file_name
- xeus_mylang_config
- Name of the `*.hpp` config file in the include folder.
* - cpp_namespace
- xeus_mylang
- Name of the C++ namespace used for this project.
* - cpp_macro_prefix
- XEUS_MYLANG
- Prefix for macros used in C++ for this project.
* - cmake_var_prefix
- XEUS_MYLANG
- Prefix for CMake variables used in CMake for this project.
* - cpp_standard
- 17
- Which C++ standard shall be used. At the moment one can choose between 14 and 17.
* - open_source_license
- BSD 3-Clause License
- Which license shall be attached to your project.