Skip to main content

Sericite

CI PyPI Python License

Sericite is a scripting language and its execution engine, built around a single idea: creating a fully isolated, arbitrarily nestable runtime environment should be a cheap, first-class operation in the language itself.

Syntax borrows a subset of Python, but Sericite source is compiled into Sericite's own instruction stream and executed by the Sericite engine — never through exec/eval. Every VM starts with zero capabilities: its own virtual IO, its own in-memory filesystem, and the ability to create child VMs. Everything else (network, host data, whatever you choose) is granted explicitly, layer by layer, through FFI.

中文文档与项目说明

Status

0.2.0 prototype. The engine is a Python reference implementation (codename Sericite-PY): zero runtime dependencies, Python ≥ 3.12, 198 regression tests. APIs and semantics may change before 1.0.

Security note. Sericite is designed for isolation, but the current prototype runs in the host process and has not been formally audited. Do not rely on it as the only boundary when executing adversarial code. See the security model for exactly what is and is not guaranteed.

Install

pip install sericite

The distribution is named sericite; the import package is sericite.

Quick start

As a CLI:

printf 'print("hello from sericite")\n' > hello.sericite
sericite hello.sericite        # hello from sericite

Embedded in Python:

from sericite import SericiteEngine

engine = SericiteEngine()
vm = engine.create_root("""
sub = VM("print('hello from a child VM')")
print(sub.run())
""")
print(vm.run(), end="")

Grant a capability to a VM (FFI):

def double(x):
    return x * 2

vm = engine.create_root("print(double(21))", functions={"double": double})
print(vm.run(), end="")    # 42

What a Sericite VM is

A VM is a cheap, self-contained workspace:

  • it cannot see its parent's variables, files, or handles, and cannot tell how deep it is nested;
  • it has its own empty in-memory filesystem (text only — structurally unable to touch the real disk);
  • resource quotas (instructions, memory, output, child VMs, nesting depth, …) can only be tightened, never loosened, and a child's consumption is charged to all its ancestors;
  • its parent can preset files, feed input, single-step it statement by statement or instruction by instruction, snapshot its state, or terminate it;
  • it can create its own child VMs — isolation is recursive, because untrusted code is.

Documentation

Document Language Contents
Design notes EN What Sericite is, why it exists, where the boundaries are (中文)
Prior art EN Safe-Tcl and related work: what Sericite inherits, what it adds (中文)
Language reference EN The language subset and semantics, self-contained (中文)
Architecture 中文 Engine structure, invariants, resource quotas
Security model EN Threat model; what the engine does and does not guarantee (中文)
Build journal 中文 How Sericite 0.1.0 was built, stage by stage, with runnable checkpoints (git checkout stage-1 … stage-6)
Behind the scenes 中文 Origin story and how AI-assisted development was used

Architecture notes, build journal, and behind-the-scenes are currently 中文-only; English versions are planned.

How this project was built

Sericite was developed with AI assistance throughout — design discussion, implementation, testing, adversarial review, and documentation drafting. What the AI did, what the author did, and how outputs were verified are documented in AI-assisted development (中文), with selected conversation records alongside.

Roadmap

  • List/dict/string methods and more ergonomic syntax
  • Performance benchmarks (child-VM creation cost, per-instruction overhead)
  • A normative language spec and a conformance test suite, so a future non-Python engine can be validated against them
  • Evaluation of a native engine (the package name is language-level on purpose: sericite survives an engine rewrite)

The name

Sericite (绢云母) is the finest-grained member of the mica family: thin silky scales that stack into sheets, and an insulator like every mica. The name keeps the three promises the project is named after — layering, insulation, lightness.

(The project was briefly named Mica/MicaLang; it was renamed after discovering the name was occupied multiple times over, including an actively developed commercial language publishing Docker images under the micalang namespace.)

License

Apache-2.0 — see NOTICE.

Metadata

Release files for sericite 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sericite 0.2.0
File Size Uploaded Provenance
sericite-0.2.0.tar.gz 169.4 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for sericite 0.2.0
File Interpreter ABI Platform
sericite-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 197.7 kB

Release files / sericite-0.2.0.tar.gz

Download URL sericite-0.2.0.tar.gz
Size 169.4 kB
Tags Source
SHA-256 checksum
How to use checksums
08c1edee75d7935dcd0f813b137b7280ad522ebd294a6839372ba18e4360219f
BLAKE2b-256 checksum
How to use checksums
78a1804fab52a416bc3713d280ae2a9d468609e9ebd49f270850eb0e18480a5e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.13

Release files / sericite-0.2.0-py3-none-any.whl

Download URL sericite-0.2.0-py3-none-any.whl
Size 28.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4e8c0c03ec5ad36a90b0ea6797190591ef15da221d5ea238ce8655a9e1ac0b88
BLAKE2b-256 checksum
How to use checksums
41b2358784f3a4516d76b1783635f98061361597d60479b6785faad6382c1eb6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.13

Security for sericite 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page