# Python Editor Embed

<a href="https://microbit-foundation.github.io/python-editor-embed/" class="typedoc-ignore">This documentation is best viewed on the documentation site rather than GitHub or NPM package site.</a>

This is a React/JavaScript library for embedding micro:bit Python Editor as an iframe.

It is intended to be used by other Micro:bit Educational Foundation projects
that need to embed Python Editor and, when the API stabilises, to be useful to others who embed Python Editor.

- [StoryBook demo of the components](https://python-editor-embed.pages.dev/)

## Usage

- [React usage documentation](docs/react.md)
- [VanillaJS usage documentation](docs/vanilla.md)

## License

This software is under the MIT open source license.

[SPDX-License-Identifier: MIT](LICENSE.md)

We use dependencies via the NPM registry as specified by the package.json file under common Open Source licenses.

Full details of each package can be found by running `license-checker`:

```bash
$ npx license-checker --direct --summary --production
```

Omit the flags as desired to obtain more detail.

## Code of Conduct

Trust, partnership, simplicity and passion are our core values we live and
breathe in our daily work life and within our projects. Our open-source
projects are no exception. We have an active community which spans the globe
and we welcome and encourage participation and contributions to our projects
by everyone. We work to foster a positive, open, inclusive and supportive
environment and trust that our community respects the micro:bit code of
conduct. Please see our [code of conduct](https://microbit.org/safeguarding/)
which outlines our expectations for all those that participate in our
community and details on how to report any concerns and what would happen
should breaches occur.
