Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brython-dev/brython

Brython (Browser Python) is an implementation of Python 3 running in the browser
https://github.com/brython-dev/brython

Last synced: 5 days ago
JSON representation

Brython (Browser Python) is an implementation of Python 3 running in the browser

Awesome Lists containing this project

README 

        
brython

=======



Brython (Browser Python) is an implementation of Python 3 running in the

browser, with an interface to the DOM elements and events.



Here is a simple example of an HTML page running Python:



```html



    

        

    



    



        

        from browser import document, alert



        def echo(event):

            alert(document["zone"].value)



        document["mybutton"].bind("click", echo)

        



        click !



    



```



To use Brython, all there is to do is:



1. Load the script [brython.js](http://brython.info/src/brython.js "Brython from the site brython.info").

2. Write Python code inside tags ``.



Main features

=============

Brython supports the syntax of [Python 3](https://www.python.org "Python Homepage"),

including comprehensions, generators, metaclasses, imports, etc.

and many modules of the CPython distribution.



Since version 3.8.0, Brython implements the Python version of the same major /

minor version number.



It includes libraries to interact with DOM elements and events,

and with existing Javascript libraries such as jQuery, D3, Highcharts, Raphael etc.

It supports the latest specs of HTML5/CSS3, and can use CSS Frameworks like

Bootstrap3, LESS, SASS etc.



Getting started

===============

Zero install !

--------------

The most simple way to get started, without anything to install, is to use the

distribution available online through [jsDelivr](https://www.jsdelivr.com/).

You can choose the latest stable release :



```html

<script type="text/javascript"

    src="https://cdn.jsdelivr.net/npm/[email protected]/brython.min.js">



```



The previous code will allow you to use raw python code, but if you import

modules from the standard library you have to load a single javascript file

with the [available stdlib](https://github.com/brython-dev/brython/tree/master/www/src/Lib):



```html



```



jsDelivr supports version ranges, so if you want the latest of the

3.13.x versions:



```html



```



or the latest of the 3.x.y versions:



```html



```



If you want to use the latest development version, you can load these scripts

instead:

```html



```



Local install

-------------

To install Brython locally, if you have a CPython distribution with `pip` :



```bash

pip install brython

```



then create a new directory and run



```bash

brython-cli install

```



or by loading the latest version of the Brython zip file from the

[releases page](https://github.com/brython-dev/brython/releases).



In both cases, the distribution includes __brython.js__ (the core Brython engine)

and __brython_stdlib.js__ (a bundle of all the files in the standard distribution).



It also includes the page __demo.html__ that shows a few examples of how you

can interact with a web page using Python as the scripting language : create

new elements, access and modify existing elements, create graphics, animations,

send Ajax requests, etc.



Test Brython online

===================

If you want to test Brython online you can visit the following:



- [Editor](http://brython.info/tests/editor.html "Online Brython Editor")

- [Console](http://brython.info/tests/console.html "Online Brython Console")



Gallery of examples

===================

There is a [gallery of examples](http://brython.info/gallery/gallery_en.html "gallery of examples")

where you can see simple and advanced examples using vanilla Brython or

interacting with Javascript libraries.



Documentation

=============

You can start by reading the official [Brython tutorial](https://brython.info/static_tutorial/en/index.html).



Full documentation is available on the [official site](http://www.brython.info "Brython Homepage").

You can read the docs in [English](http://brython.info/static_doc/en/intro.html) and

[French](http://brython.info/static_doc/fr/intro.html).



Curious about [how Brython works](https://github.com/brython-dev/brython/wiki/How%20Brython%20works) ?



A [tutorial](https://github.com/brython-dev/brython/wiki/Writing-an-Android-application)

explains how to build Android applications with Brython.



You can also [Ask Brython Guru](https://gurubase.io/g/brython), it is a Brython-focused AI to answer your questions.



Community (questions, feedback, issues, new features, ...)

==========================================================

You can subscribe and post to the

[mailing list](https://groups.google.com/forum/?fromgroups=#!forum/brython "Brython Main Mailing List").



If you find a bug/issue or do you want to see a new feature in Brython, please,

[open a new issue](https://github.com/brython-dev/brython/issues "Brython GitHub Issues").



If you want to contribute to Brython, please read the [contributing guide](https://github.com/brython-dev/brython/blob/master/CONTRIBUTING.md).



Thank you

=========



- [BrowserStack](http://www.browserstack.com) for providing an access

to their online testing environment.