Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.rst #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Jaspy
**JASPY**
=====

|pypi| |build| |coverage| |docs| |gitter|

Jaspy is a Python VM written entirely from scratch in JavaScript with some unique
features. Jaspy supports multiple threads, comes with an integrated debugger which
**Jaspy** is a Python VM written entirely from scratch in JavaScript with some unique
features. **Jaspy** supports multiple threads, comes with an integrated debugger which
offers remote debugging and provides a flexible preprocessor based architecture.
Speed is explicitly not a main goal of this project. Jaspy aims to illustrate how
Speed is explicitly not a main goal of this project. **Jaspy** aims to illustrate how the
web programming on the client side could be done by exploring new ways.


Features
**Features.**
--------
- **suspendable** interpreter with support for **threading** and greenlets
- integrated **debugger** and interactive remote debugging (CLI, PyCharm, …)
Expand All @@ -23,7 +23,7 @@ Features
.. _time: https://github.com/koehlma/jaspy/blob/master/modules/time.js
.. _dom: https://github.com/koehlma/jaspy/blob/master/modules/dom.js

Quickstart
**Quickstart.**
----------
Jaspy comes with an integrated development server and interactive debugger!

Expand Down Expand Up @@ -55,7 +55,7 @@ Visit http://localhost:8080/hello.html in your browser and click run:
:align: center


Alternatives
**Alternatives.**
------------
There are already many other Python-to-JavaScript approaches out there:

Expand All @@ -71,7 +71,7 @@ Jaspy, which are the fully suspendable interpreter with threading support, the
integrated debugger and the flexible, preprocessor based architecture.


Speed
**Speed.**
-----
Just to get an impression how slow Jaspy really is!

Expand All @@ -91,12 +91,12 @@ Just to get an impression how slow Jaspy really is!
| PyPy.js (warm) | 847457 |
+-----------------------------------------------+------------------+

However this is a somewhat unfair benchmark because no dom manipulation or anything
However, this is a somewhat unfair benchmark because no dom manipulation or anything
else browser specific is going on. Surprisingly threading and debugging introduces nearly
no overhead.


State
**State.**
-----
This project is still in an alpha state. The APIs are unstable, it is untested and not
ready for productive use. Some of the features listed above are not yet implemented.
Expand All @@ -106,7 +106,7 @@ much less spare time. Therefore it might take a while until I will be able to in
more time into it. However I very welcome all sorts of contributions.


Contributions
**Contributions.**
-------------
If you like the ideas of Jaspy feel free to join, there are many things to do:

Expand All @@ -125,7 +125,7 @@ Do not hesitate to contribute or ask if there is anything unclear about the code
process of contributing in general.


Structure
**Structure.**
---------

:libs: third-party dependencies
Expand All @@ -134,7 +134,7 @@ Structure
:jaspy: Python server, converter and remote debugger


Credits
**Credits.**
-------
Many thanks to the `Brython <http://www.brython.info/>`_ project for the inspiration for
many parts of code of the builtin-classes. Many thanks also to the book `“500 Lines or
Expand Down