{"id":21070723,"url":"https://github.com/microbit-foundation/python-editor-v3","last_synced_at":"2025-05-16T05:31:02.887Z","repository":{"id":37212944,"uuid":"336385657","full_name":"microbit-foundation/python-editor-v3","owner":"microbit-foundation","description":"Micro:bit Educational Foundation Python Editor V3","archived":false,"fork":false,"pushed_at":"2025-04-17T15:58:52.000Z","size":35032,"stargazers_count":62,"open_issues_count":109,"forks_count":37,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-18T06:20:18.434Z","etag":null,"topics":["editor","education","learning-python","microbit","microcontroller","micropython","python"],"latest_commit_sha":null,"homepage":"https://python.microbit.org","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microbit-foundation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-05T20:48:16.000Z","updated_at":"2025-04-17T15:43:41.000Z","dependencies_parsed_at":"2023-02-14T17:01:37.021Z","dependency_job_id":"3ae43a2b-8946-493c-9928-159f725e9f9c","html_url":"https://github.com/microbit-foundation/python-editor-v3","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microbit-foundation%2Fpython-editor-v3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microbit-foundation%2Fpython-editor-v3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microbit-foundation%2Fpython-editor-v3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microbit-foundation%2Fpython-editor-v3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microbit-foundation","download_url":"https://codeload.github.com/microbit-foundation/python-editor-v3/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254473854,"owners_count":22077187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["editor","education","learning-python","microbit","microcontroller","micropython","python"],"created_at":"2024-11-19T18:48:05.702Z","updated_at":"2025-05-16T05:30:57.870Z","avatar_url":"https://github.com/microbit-foundation.png","language":"TypeScript","readme":"# micro:bit Python Editor V3\n\nThis project is a web-based code editor that targets the [MicroPython](https://micropython.org) version of the [Python programming language](http://python.org/).\n\nCode written with this editor is expected to run on the [BBC micro:bit device](https://microbit.org).\n\nTry it out at https://python.microbit.org/\n\n\u003cfigure\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/44397098/193227581-58d86d58-d679-4244-ac80-2282007a20b9.png\" alt=\"Screenshot of the Python editor showing the code editing area, Reference documentation and micro:bit simulator\" width=\"100%\"\u003e\n  \u003cfigcaption\u003eThe image shows the micro:bit-branded deployment\u003c/figcaption\u003e  \n\u003c/figure\u003e\n\n## Previous versions\n\nFor more background about how this editor relates to the original Python Editor project, see [this explanation](https://github.com/bbcmicrobit/PythonEditor/issues/391).\n\nThe V2 editor project is still available at https://python.microbit.org/v/2 and its source code can be found in GitHub at https://github.com/bbcmicrobit/PythonEditor.\n\n## Building and running the editor\n\nWe've written a [technical overview](./docs/tech-overview.md) that's a good starting point for working on the Python Editor or for using ideas and components from the app in other projects. We'd love to hear from you if you're making use of this project. You can get in touch via [support](https://support.microbit.org/).\n\nGetting up and running:\n\n1. Ensure you have a working [Node.js environment](https://nodejs.org/en/download/). We recommend using the LTS version of Node and NPM version 8 or newer.\n2. Checkout this repository with Git. GitHub have some [learning resources for Git](https://docs.github.com/en/get-started/quickstart/git-and-github-learning-resources) that you may find useful.\n3. Install the dependencies by running `npm install` on the command line in the checkout folder.\n4. Choose from the NPM scripts documented below. Try `npm start` if you're not sure.\n\n### `npm start`\n\nRuns the app in the development mode.\n\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\n\nThis does not show TypeScript or lint errors.\nUse the eslint plugin for your editor and consider also running `npm run typecheck:watch` to see full type checking errors.\n\n### `npm test`\n\nLaunches the [test runner](https://vitest.dev/) in interactive mode (unless the `CI` environment variable is defined).\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\nIf you have a connected micro:bit device, then setting the environment variable `TEST_MODE_DEVICE=1` will enable additional tests that will connect to your micro:bit. The tests will overwrite programs and data on the micro:bit.\n\n### `npm run test:e2e`\n\nLaunches the test runner in the interactive watch mode running the end to end tests.\n\nThese are excluded from the normal test run.\n\nThe tests expect the app to already be running on http://localhost:3000, for example via `npm start`.\n\nWe use [Playwright](https://playwright.dev/).\n\nThe CI tests run these end-to-end tests against a production build.\n\n### `npm run build`\n\nBuilds the app for production to the `build` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\n## Deployments\n\nMost users should use the supported Foundation deployment at https://python.microbit.org/\n\nThe editor is deployed by [GitHub actions](https://github.com/microbit-foundation/python-editor-v3/actions).\n\nThe `main` branch is deployed to https://python.microbit.org/v/beta on each push.\n\nOther branches (e.g. for PRs) are deployed to https://review-python-editor-v3.microbit.org/{branch}. Special characters in the branch name are replaced by hyphens. Deployments will not run in forks.\n\n## License\n\nThis software is under the MIT open source license.\n\n[SPDX-License-Identifier: MIT](LICENSE)\n\nBinaries for MicroPython are included for micro:bit V1 ([license](https://github.com/bbcmicrobit/micropython/blob/master/LICENSE)) and micro:bit V2 ([license](https://github.com/microbit-foundation/micropython-microbit-v2/blob/master/LICENSE)). Both are MIT licensed.\n\nPython diagnostics and autocomplete use a fork of Microsoft's Pyright type checker which has been [modified by us](public/workers/PYRIGHT_README.txt) to run as a Web Worker. Pyright is © Microsoft Corporation and [used under an MIT license](public/workers/PYRIGHT_LICENSE.txt).\n\nWe use dependencies via the NPM registry as specified by the package.json file under common Open Source licenses.\n\nFull details of each package can be found by running `license-checker`:\n\n```bash\n$ npx license-checker --direct --summary --production\n```\n\nOmit the flags as desired to obtain more detail.\n\n## Code of Conduct\n\nTrust, partnership, simplicity and passion are our core values we live and\nbreathe in our daily work life and within our projects. Our open-source\nprojects are no exception. We have an active community which spans the globe\nand we welcome and encourage participation and contributions to our projects\nby everyone. We work to foster a positive, open, inclusive and supportive\nenvironment and trust that our community respects the micro:bit code of\nconduct. Please see our [code of conduct](https://microbit.org/safeguarding/)\nwhich outlines our expectations for all those that participate in our\ncommunity and details on how to report any concerns and what would happen\nshould breaches occur.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrobit-foundation%2Fpython-editor-v3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrobit-foundation%2Fpython-editor-v3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrobit-foundation%2Fpython-editor-v3/lists"}