mirror of
https://github.com/pyscript/pyscript.git
synced 2026-02-18 22:00:37 -05:00
bf3995d45c
* update README.md Corrected the grammatical mistakes to make the documents easier to read and understand. * update README.md * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Update README.md made required changes * update CONTRIBUTING.md made necessary changes. * fixed a typo in CONTRIBUTING.md * removed unnecessary file * removed unnecessary file * removed unnecessary words Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
48 lines
2.2 KiB
Markdown
48 lines
2.2 KiB
Markdown
# PyScript
|
|
|
|
## What is PyScript
|
|
|
|
### Summary
|
|
|
|
PyScript is a Pythonic alternative to Scratch, JSFiddle, and other "easy to use" programming frameworks, with the goal of making the web a friendly, hackable place where anyone can author interesting and interactive applications.
|
|
|
|
To get started see the [getting started tutorial](docs/tutorials/getting-started.md).
|
|
|
|
For examples see [here](examples).
|
|
|
|
### Longer Version
|
|
PyScript is a meta project that aims to combine multiple open technologies into a framework that allows users to create sophisticated browser applications with Python. It integrates seamlessly with the way the DOM works in the browser and allows users to add Python logic in a way that feels natural both to web and Python developers.
|
|
|
|
## Try PyScript
|
|
|
|
To try PyScript, import the appropriate pyscript files to your html page with:
|
|
```html
|
|
<link rel="stylesheet" href="https://pyscript.net/alpha/pyscript.css" />
|
|
<script defer src="https://pyscript.net/alpha/pyscript.js"></script>
|
|
```
|
|
You can then use PyScript components in your html page. PyScript currently implements the following elements:
|
|
|
|
* `<py-script>`: can be used to define python code that is executable within the web page. The element itself is not rendered to the page and is only used to add logic
|
|
* `<py-repl>`: creates a REPL component that is rendered to the page as a code editor and allows users to write executable code
|
|
|
|
Check out the [the examples directory](examples) folder for more examples on how to use it, all you need to do is open them in Chrome.
|
|
|
|
## How to Contribute
|
|
|
|
Read the [contributing guide](CONTRIBUTING.md) to learn about our development process, reporting bugs and improvements, creating issues and asking questions.
|
|
|
|
## Resources
|
|
|
|
* [Discussion board](https://community.anaconda.cloud/c/tech-topics/pyscript)
|
|
* [Home Page](https://pyscript.net/)
|
|
* [Blog Post](https://engineering.anaconda.com/2022/04/welcome-pyscript.html)
|
|
|
|
## Notes
|
|
|
|
* This is an extremely experimental project, so expect things to break!
|
|
* PyScript has been only tested on Chrome at the moment.
|
|
|
|
## Governance
|
|
|
|
The [PyScript organization governance](https://github.com/pyscript/governance) is documented in a separate repository.
|