thonny-sealed 1.0.0b1

Installation

In Thonny

The plug-in can be easily installed via Thonny. Go to Tools menu and select Manage plug-ins...:

Search for thonny-sealed on PyPI and click on the link to install it:

pip install --user thonny-sealed

Usage

Thonny-sealed inspects the blocks of code in your files based on the special comments. The user is prevented from editing the content within the sealed blocks.

• Mark the start of every block with a comment line # sealed: on. Analogously, mark the end of a sealed block with # sealed: off. Alternatively, you can use the visually more appealing comments # sealed: 🡻 and # sealed: 🡹, respectively.

  Here is an example file:

"""Provide some service."""

# sealed: on
def some_func() -> None:
    """Do something."""
    # sealed: off

• Call in the terminal (where plug-in has been installed) to “seal” the blocks with the hashes:

thonny-seal --input path/to/the/file.py --write

• Your file is now sealed and can be loaded in the plug-in. The content of the file is:

"""Provide some service."""

# sealed: on 3a9ff394
def some_func() -> None:
    """Do something."""
    # sealed: off 3a9ff394

Alternatively, you can write the output to the STDOUT if you do not want to overwrite the file by omitting the --write argument:

thonny-sealed --input path/to/the/file.py

Contributing

Feature requests or bug reports are always very, very welcome!

Please see quickly if the issue does not already exist in the issue section and, if not, create a new issue.

You can also contribute in code. Please see CONTRIBUTING.rst.

Versioning

We follow Semantic Versioning. The version X.Y.Z indicates:

• X is the major version (backward-incompatible),

• Y is the minor version (backward-compatible), and

• Z is the patch version (backward-compatible bug fix).