Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a2f2cd3

Browse files
committed
add minimal info the README file
1 parent 03da071 commit a2f2cd3

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,37 @@
1-
# pyscript
1+
# PyScript
2+
3+
## What is PyScript
4+
5+
### tl;dr
6+
PyScript is a Pythonic alternative to Scratch, JSFiddle or other "easy to use" programming frameworks, making the web a friendly, hackable, place where anyone can author interesting and interactive applications.
7+
8+
### Longer Version
9+
PyScript is a meta project that aims to combine multiple open technologies to create a framework for users to use Python (and other languages) to create sophisticated applications in the browser. It highly integrate with the way the DOM works in the browser and allows users to add logic, in Python, in a way that feel natural to web as well as Python developers.
10+
11+
## Try PyScript
12+
13+
To try PyScript, import the pyscript to your html page with:
14+
```
15+
<link rel="stylesheet" href="pyscript.css" />
16+
<script defer src="pyscript.js"></script>
17+
```
18+
At that point, you can then use PyScript components in your html page. PyScript currently implements the following elements:
19+
20+
* `<py-script>`: that can be used to define python code that is execute withing the web page. The element itself is not rendered to the page and only used to add logic
21+
* `<py-repl>`: creates a REPL component that is rendered to the page as a code editor and allows users to right code that can be executed
22+
23+
Check out the `/examples` folder for more examples on how to use it, all you need to do is open them in Chrome.
24+
25+
## How to Contribute
26+
27+
To contribute:
28+
29+
* clone the repo
30+
* cd into the main project folder with `cd pyscriptjs`
31+
* install the dependencies with `npm install`
32+
* run `npm run dev` to build and run the dev server. This will also watch for changes and rebuild when a file is saved
33+
34+
## Notes:
35+
36+
* This is an extremely experimental project, so expect things to break!
37+
* PyScript has been only tested on Chrome, at the moment.

0 commit comments

Comments
 (0)