2021-04-06 22:11:00 +00:00
|
|
|
# About Pyodide
|
2020-05-19 16:14:56 +00:00
|
|
|
|
2021-04-06 22:11:00 +00:00
|
|
|
Python with the scientific stack, compiled to WebAssembly.
|
2020-05-19 16:14:56 +00:00
|
|
|
|
2021-04-06 22:11:00 +00:00
|
|
|
Pyodide may be used in any context where you want to run Python inside a web
|
|
|
|
browser.
|
|
|
|
|
2021-06-19 22:49:25 +00:00
|
|
|
Pyodide brings the Python 3.9 runtime to the browser via WebAssembly, along with
|
2021-04-06 22:11:00 +00:00
|
|
|
the Python scientific stack including NumPy, Pandas, Matplotlib, SciPy, and
|
2021-04-09 18:30:40 +00:00
|
|
|
scikit-learn. The [packages
|
2021-04-19 09:37:59 +00:00
|
|
|
directory](https://github.com/pyodide/pyodide/tree/main/packages) lists over
|
2021-04-09 18:30:40 +00:00
|
|
|
75 packages which are currently available. In addition it's possible to install
|
|
|
|
pure Python wheels from PyPi.
|
2020-05-19 16:14:56 +00:00
|
|
|
|
2021-09-29 08:01:53 +00:00
|
|
|
Pyodide provides transparent conversion of objects between JavaScript and
|
2020-05-19 16:14:56 +00:00
|
|
|
Python. When used inside a browser, Python has full access to the Web APIs.
|
|
|
|
|
2021-03-20 18:15:08 +00:00
|
|
|
## History
|
2021-07-26 23:00:27 +00:00
|
|
|
|
2021-03-20 18:15:08 +00:00
|
|
|
Pyodide was created in 2018 by [Michael Droettboom](https://github.com/mdboom)
|
2021-04-21 20:57:45 +00:00
|
|
|
at Mozilla as part of the [Iodide
|
2021-04-06 22:11:00 +00:00
|
|
|
project](https://github.com/iodide-project/iodide). Iodide is an experimental
|
|
|
|
web-based notebook environment for literate scientific computing and
|
|
|
|
communication.
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
See the {ref}`contributing guide <how_to_contribute>` for tips on filing issues,
|
|
|
|
making changes, and submitting pull requests. Pyodide is an independent and
|
|
|
|
community-driven open-source project. The decision making process is outlined in
|
|
|
|
{ref}`project-governance`.
|
|
|
|
|
2021-07-31 17:57:01 +00:00
|
|
|
## Citing
|
|
|
|
|
|
|
|
If you use Pyodide for a scientific publication, we would appreciate citations.
|
2021-08-11 10:16:48 +00:00
|
|
|
Please find us [on Zenodo](https://zenodo.org/record/5156931) and use the citation
|
2021-07-31 17:57:01 +00:00
|
|
|
for the version you are using. You can replace the full author
|
|
|
|
list from there with "The Pyodide development team" like in the example below:
|
|
|
|
|
|
|
|
```
|
2021-08-11 10:16:48 +00:00
|
|
|
@software{pyodide_2021,
|
2021-07-31 17:57:01 +00:00
|
|
|
author = {The Pyodide development team},
|
|
|
|
title = {pyodide/pyodide},
|
2021-08-11 10:16:48 +00:00
|
|
|
month = aug,
|
2021-07-31 17:57:01 +00:00
|
|
|
year = 2021,
|
|
|
|
publisher = {Zenodo},
|
2021-08-11 10:16:48 +00:00
|
|
|
version = {0.18.0},
|
|
|
|
doi = {10.5281/zenodo.5156931},
|
|
|
|
url = {https://doi.org/10.5281/zenodo.5156931}
|
2021-07-31 17:57:01 +00:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
2021-04-28 13:48:54 +00:00
|
|
|
## Communication
|
|
|
|
|
|
|
|
- Mailing list: [mail.python.org/mailman3/lists/pyodide.python.org/](https://mail.python.org/mailman3/lists/pyodide.python.org/)
|
|
|
|
- Gitter: [gitter.im/pyodide/community](https://gitter.im/pyodide/community)
|
|
|
|
- Twitter: [twitter.com/pyodide](https://twitter.com/pyodide)
|
|
|
|
- Stack Overflow: [stackoverflow.com/questions/tagged/pyodide](https://stackoverflow.com/questions/tagged/pyodide)
|
|
|
|
|
2021-11-03 08:02:21 +00:00
|
|
|
## Donations
|
|
|
|
|
|
|
|
We accept donations to the Pyodide project at
|
|
|
|
[opencollective.com/pyodide](https://opencollective.com/pyodide). All donations
|
|
|
|
are processed by the [Open Source Collective](https://www.oscollective.org/) -- a
|
|
|
|
nonprofit organization that acts as our fiscal host.
|
|
|
|
|
|
|
|
Funds will be mostly spent to organize in-person code sprints and to cover
|
|
|
|
infrastructure costs for distributing packages built with Pyodide.
|
|
|
|
|
2021-04-06 22:11:00 +00:00
|
|
|
## License
|
2021-03-20 18:15:08 +00:00
|
|
|
|
2021-04-06 22:11:00 +00:00
|
|
|
Pyodide uses the [Mozilla Public License Version
|
|
|
|
2.0](https://choosealicense.com/licenses/mpl-2.0/).
|
2021-03-20 18:15:08 +00:00
|
|
|
|
|
|
|
## Infrastructure support
|
|
|
|
|
2021-04-06 22:11:00 +00:00
|
|
|
We would like to thank,
|
2021-07-26 23:00:27 +00:00
|
|
|
|
|
|
|
- [Mozilla](https://www.mozilla.org/en-US/) and
|
|
|
|
[CircleCl](https://circleci.com/) for Continuous Integration resources
|
|
|
|
- [JsDelivr](https://www.jsdelivr.com/) for providing a CDN for Pyodide
|
|
|
|
packages
|
|
|
|
- [ReadTheDocs](https://readthedocs.org/) for hosting the documentation.
|