This repository has been archived by the owner on Dec 27, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# Jupyter-PHP | ||
|
||
[![Author](http://img.shields.io/badge/[email protected]?style=flat-square)](https://twitter.com/castarco) | ||
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE) | ||
[![Packagist Version](https://img.shields.io/packagist/v/Litipk/jupyter-php.svg?style=flat-square)](https://packagist.org/packages/Litipk/jupyter-php) | ||
|
||
## Introduction | ||
|
||
**Jupyter-PHP** is a PHP kernel for [*Jupyter*](http://jupyter.org). This project is inspired on | ||
[https://github.com/dawehner/jupyter-php](https://github.com/dawehner/jupyter-php), some bits of code from the old | ||
*IPython* kernel have been used in this new *Jupyter* kernel. | ||
|
||
In addition to the Jupyter compatibility, the new Jupyter-PHP adds a lot of improvements, like the integration with | ||
[PsySH](http://psysh.org/) in order to provide: | ||
|
||
* *"memory"*: the old kernel was unable to keep variables to allow reuse them later. | ||
* online documentation with the `doc` command. *Not yet implemented* | ||
* code introspection with the `ls` command. *Not yet implemented* | ||
* errors introspection with the `wtf` command. *Not yet implemented* | ||
|
||
## Getting started | ||
|
||
To be written. | ||
|
||
## Learn more | ||
|
||
* [Chat Room](https://gitter.im/Litipk/Jupyter-PHP) : If you want to have a real-time chat with other Jupyter-PHP users or developers, you can do it here. | ||
* [Group / Mail List](https://groups.io/g/jupyter-php) : If a chat room isn't enough to post your doubts or ideas, you can join to our mail list. | ||
|
||
## How to contribute | ||
|
||
* First of all, you can take a look on the [bugtracker](https://github.com/Litipk/php-bignumbers/issues) and decide if there is something that you want to do :wink: . If you think there are missing improvements in this file, then you are invited to modify the TODO list. | ||
* You can also send us bug reports using the same bugtracker. | ||
* If you are really interested on helping to improve Litipk\BigNumbers, we recommend to read the [contributing guidelines](https://github.com/Litipk/php-bignumbers/blob/master/CONTRIBUTING.md). | ||
|
||
|
||
## License | ||
|
||
Jupyter-PHP is licensed under the [MIT License](https://github.com/Litipk/Jupyter-PHP/blob/master/LICENSE). |