Skip to content

Update Python editor content #414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
microbit-matt-hillsdon wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update Python editor content #414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions software/micropython.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ It provides two services:
- [microFS](https://microfs.readthedocs.io/en/latest/)
A simple command line tool and module for interacting with the limited file system provided by MicroPython on the BBC micro:bit.

Finally, there are great [tutorials for MicroPython on the micro:bit](https://microbit-micropython.readthedocs.io/en/latest/tutorials/introduction.html).
Finally, there are great [tutorials for MicroPython on the micro:bit](https://microbit-micropython.readthedocs.io/en/v2-docs/tutorials/introduction.html).

## What is MicroPython?

Expand Down Expand Up @@ -120,7 +120,7 @@ Many people in the international Python community have contributed free-to-use r

### Documentation

Tutorials and API documentation for developers can be [found here](https://microbit-micropython.readthedocs.io/en/latest/).
Tutorials and API documentation for developers can be [found here](https://microbit-micropython.readthedocs.io/en/v2-docs/).

### Logging an Issue with the Development Team

Expand Down
37 changes: 18 additions & 19 deletions software/python-editor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,35 +11,34 @@ lang: en

## Overview

The [Python Editor](https://python.microbit.org) is a free, browser based coding environment for creating [MicroPython]({{ "/software/micropython/" | relative_url }}) projects with the BBC micro:bit.
The [Python Editor](https://python.microbit.org) is a free, open source, browser-based coding environment for creating [MicroPython]({{ "/software/micropython/" | relative_url }}) projects with the BBC micro:bit.

Use common snippets of code, add/remove files and modules, and upload/download .hex or .py files.
### Documentation

The Python editor is based upon the [Ace editor](http://ace.c9.io) and includes syntax highlighting, code folding and (semi) intelligent auto-indentation.
For using the editor:

### Source
- The [Reference](https://python.microbit.org/v/3/reference), [Ideas](https://python.microbit.org/v/3/ideas) and [API](https://python.microbit.org/v/3/api) tabs in the editor itself
- [User guide](https://microbit-micropython.readthedocs.io/en/latest/)
- [MicroPython reference](https://microbit-micropython.readthedocs.io/en/v2-docs/) provides information and examples on using the API

The upstream source code for the Python Editor can be found at [github.com/bbcmicrobit/PythonEditor](https://github.com/bbcmicrobit/PythonEditor)
For developing the editor or understanding how it works:

The micro:bit target depends a closed source versioning repository that facilitates releases at `/v/`, for example the beta editor [https://python.microbit.org/v/beta](https://python.microbit.org/v/beta) and previous releases.
- [GitHub](https://github.com/microbit-foundation/python-editor-v3)
- [Technical overview](https://github.com/microbit-foundation/python-editor-v3/blob/main/docs/tech-overview.md)

### Offline
### Reusable software components

It is possible to use the Python Editor offline to generate, upload and download .hex or .py files. However, refreshing the browser resets the editor.
The [micro:bit MicroPython simulator](https://github.com/microbit-foundation/micropython-microbit-v2-simulator#readme) is a separate component that you can embed in your own software projects.

### Documentation
The [micro:bit connection](https://microbit-foundation.github.io/microbit-connection/) npm package is used to connect to and flash the micro:bit over WebUSB.

- [MicroPython reference](https://microbit-micropython.readthedocs.io/en/v1.0.1/) provides information and examples on using the blocks
- [Developer setup](https://github.com/bbcmicrobit/PythonEditor/blob/master/README.rst)
- [Filesystem](https://github.com/bbcmicrobit/PythonEditor/blob/master/docs/filesystem.md)
- [Translation strategy](https://github.com/bbcmicrobit/PythonEditor/blob/master/docs/translations.md)
- [Embedding the editor](https://github.com/bbcmicrobit/PythonEditor/blob/master/docs/embedEditor.md)
The MicroPython file system that stores the user's Python code can be manipulated with the [microbit-fs](https://microbit-foundation.github.io/microbit-fs/) npm package.

### Community
### Previous version

There are a variety of ways to get involved and interact:
The micro:bit Python Editor (V2) is still available at [https://python.microbit.org/v/2](https://python.microbit.org/v/2) with source code at [https://github.com/bbcmicrobit/PythonEditor](https://github.com/bbcmicrobit/PythonEditor).

### Community

- Join the [micro:bit developer community on Slack]({{ "/community/" | relative_url }})
- Raise a [Python Editor issue or feature request](https://github.com/bbcmicrobit/PythonEditor/issues)
- Ask a question on the [MicroPython forum for micro:bit](https://forum.micropython.org/viewforum.php?f=17&sid=de047c3e944921889becbc00f02a918f)
- Raise a [Python Editor issue or feature request](https://github.com/microbit-foundation/python-editor-v3/issues)
- Help [Translate the Python Editor](https://support.microbit.org/en/support/solutions/articles/19000106022-translating-the-python-editor) into your own language.