Metadata-Version: 2.0
Name: spring-kernel
Version: 1.0.2
Summary: Jupyter kernel for SpringRTS
Home-page: https://github.com/gajop/spring-kernel
Author: gajop
Author-email: gajopetrovic@gmail.com
License: MIT
Keywords: springrts jupyter ipython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Framework :: IPython
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Requires-Dist: setuptools
Requires-Dist: ipykernel (>=4.0)
Requires-Dist: jupyter-client (>=4.0)
Requires-Dist: jupyter

SpringRTS IPython kernel for Jupyter notebooks

Run Spring code remotely via Jupyter notebooks.
4X: explore, experiment, extend and execute.

For usage docs see `%help and %lsmagic` inside the notebook.

Install
=======

Obtain a writable Python environment (virtualenv is suggested).

Install with pip:
```
pip install spring-kernel
```

Install the kernel (you probably want to include --user):
```
jupyter spring_kernel install --user
```

Install the widget and gadget to your Spring project.
Copy spring-kernel to your project's libs folder, and then copy the `api_spring_kernel_load.lua` to the `LuaUI/widgets` and `LuaRules/gadgets` folders.

Running
=======

Start your Spring project, and then start the jupyter notebook with:
```
jupyter notebook
```

You can then create SpringRTS kernel notebooks in the browser. 


