IPython Kernel for Lua
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 96 commits ahead of neomantra:master.

README.md

IPyLua: Lua IPython Kernel

This is a kernel to support Lua with IPython. It is pure Lua and should work with both Lua and LuaJIT.

Requirements

The following Lua libraries are required:

  • lzmq zeromq for Lua

The code for Lua JSON of dkjson and uuid has been copied into this module to avoid external dependencies.

Installation

The installation process is janky right now.

  • Install the Requirements: zeromq and lzmq.

  • Create a profile with IPython:

$ ipython profile create IPyLua
  • Modify the profile's ipython_config.py to use IPyLua. This will be at either ~/.config/ipython/profile_IPyLua/ipython_config.py or ~/.ipython/profile_IPyLua/ipython_config.py:
# Configuration file for ipython.
   
c = get_config()
   
c.KernelManager.kernel_cmd = [
    "luajit", # select your Lua interpreter here (lua5.2, lua5.1, luajit)
    "IPyLua/IPyLuaKernel.lua",  # probably need full path
    "{connection_file}"
]
   
# Disable authentication.
c.Session.key = b''
c.Session.keyfile = b''
  • Copy the content of config folder into your ~/.ipython/profile_IPyLua/static/custom/ folder.

  • Invoke IPython with this Lua kernel:

$ ipython console --profile IPyLua
# or 
$ ipython notebook --profile IPyLua

TODO

  • Get the execute side of things working
  • Go through all the TODOs in the source file
  • Make a luarock spec
  • Make an installer
  • HMAC

Acknowledgements

Thanks to Evan Wies who has written the original code lua_ipython_kernel.

Thanks to Andrew Gibiansky for his IHaskell article that inspired this.

Thanks to the makers of the dependencies of this library, who made this pretty easy to create: Robert Jakabosky, David Kolf, and Thijs Schreijer.

And of course thanks to the IPython folks .

LICENSE

IPyLua is distributed under the MIT License.

IPyLua Copyright (c) 2015 Francisco Zamora-Martinez. Simplified, less deps and making it work.

Original name and copyright: lua_ipython_kernel Copyright (c) 2013 Evan Wies. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.