https://github.com/RustPython/RustPython Skip to content Navigation Menu Toggle navigation Sign in * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + GitHub Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions By size + Enterprise + Teams + Startups By industry + Healthcare + Financial services + Manufacturing By use case + CI/CD & Automation + DevOps + DevSecOps * Resources Topics + AI + DevOps + Security + Software Development Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} RustPython / RustPython Public * Notifications You must be signed in to change notification settings * Fork 1.2k * Star 18.2k A Python Interpreter written in Rust rustpython.github.io License MIT, CC-BY-4.0 licenses found Licenses found MIT LICENSE CC-BY-4.0 LICENSE-logo 18.2k stars 1.2k forks Branches Tags Activity Star Notifications You must be signed in to change notification settings * Code * Issues 301 * Pull requests 92 * Discussions * Actions * Projects 0 * Wiki * Security * Insights Additional navigation options * Code * Issues * Pull requests * Discussions * Actions * Projects * Wiki * Security * Insights RustPython/RustPython This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main BranchesTags Go to file Code Folders and files Name Name Last commit Last commit message date Latest commit History 13,836 Commits .cargo .cargo .devcontainer .devcontainer .github .github .theia .theia .vscode .vscode Lib Lib architecture architecture benches benches common common compiler compiler derive-impl derive-impl derive derive examples examples extra_tests extra_tests jit jit pylib pylib scripts scripts src src stdlib stdlib vm vm wasm wasm .cspell.json .cspell.json .dockerignore .dockerignore .flake8 .flake8 .gitattributes .gitattributes .gitignore .gitignore .gitpod.Dockerfile .gitpod.Dockerfile .gitpod.yml .gitpod.yml .mailmap .mailmap Cargo.lock Cargo.lock Cargo.toml Cargo.toml DEVELOPMENT.md DEVELOPMENT.md Dockerfile.bin Dockerfile.bin Dockerfile.wasm Dockerfile.wasm LICENSE LICENSE LICENSE-logo LICENSE-logo README.md README.md code-of-conduct.md code-of-conduct.md crawl_sourcecode.py crawl_sourcecode.py demo_closures.py demo_closures.py deny.toml deny.toml logo.png logo.png pdc.sh pdc.sh rust-toolchain.toml rust-toolchain.toml rustfmt.toml rustfmt.toml wapm.toml wapm.toml whats_left.py whats_left.py View all files Repository files navigation * README * Code of conduct * MIT license * CC-BY-4.0 license [logo] RustPython A Python-3 (CPython >= 3.12.0) Interpreter written in Rust . Build Status codecov License: MIT Contributors Discord Shield docs.rs Crates.io dependency status WAPM package Open in Gitpod Usage Check out our online demo running on WebAssembly. RustPython requires Rust latest stable version (e.g 1.67.1 at February 7th 2023). If you don't currently have Rust installed on your system you can do so by following the instructions at rustup.rs. To check the version of Rust you're currently running, use rustc --version. If you wish to update, rustup update stable will update your Rust installation to the most recent stable release. To build RustPython locally, first, clone the source code: git clone https://github.com/RustPython/RustPython Then you can change into the RustPython directory and run the demo (Note: --release is needed to prevent stack overflow on Windows): $ cd RustPython $ cargo run --release demo_closures.py Hello, RustPython! Or use the interactive shell: $ cargo run --release Welcome to rustpython >>>>> 2+2 4 NOTE: For windows users, please set RUSTPYTHONPATH environment variable as Lib path in project directory. (e.g. When RustPython directory is C:\RustPython, set RUSTPYTHONPATH as C:\RustPython\Lib) You can also install and run RustPython with the following: $ cargo install --git https://github.com/RustPython/RustPython $ rustpython Welcome to the magnificent Rust Python interpreter >>>>> If you'd like to make https requests, you can enable the ssl feature, which also lets you install the pip package manager. Note that on Windows, you may need to install OpenSSL, or you can enable the ssl-vendor feature instead, which compiles OpenSSL for you but requires a C compiler, perl, and make. OpenSSL version 3 is expected and tested in CI. Older versions may not work. Once you've installed rustpython with SSL support, you can install pip by running: cargo install --git https://github.com/RustPython/RustPython --features ssl rustpython --install-pip You can also install RustPython through the conda package manager, though this isn't officially supported and may be out of date: conda install rustpython -c conda-forge rustpython WASI You can compile RustPython to a standalone WebAssembly WASI module so it can run anywhere. Build cargo build --target wasm32-wasi --no-default-features --features freeze-stdlib,stdlib --release Run by wasmer wasmer run --dir `pwd` -- target/wasm32-wasi/release/rustpython.wasm `pwd`/extra_tests/snippets/stdlib_random.py Run by wapm $ wapm install rustpython $ wapm run rustpython >>>>> 2+2 4 Building the WASI file You can build the WebAssembly WASI file with: cargo build --release --target wasm32-wasi --features="freeze-stdlib" Note: we use the freeze-stdlib to include the standard library inside the binary. You also have to run once rustup target add wasm32-wasi. JIT (Just in time) compiler RustPython has a very experimental JIT compiler that compile python functions into native code. Building By default the JIT compiler isn't enabled, it's enabled with the jit cargo feature. cargo run --features jit This requires autoconf, automake, libtool, and clang to be installed. Using To compile a function, call __jit__() on it. def foo(): a = 5 return 10 + a foo.__jit__() # this will compile foo to native code and subsequent calls will execute that native code assert foo() == 15 Embedding RustPython into your Rust Applications Interested in exposing Python scripting in an application written in Rust, perhaps to allow quickly tweaking logic where Rust's compile times would be inhibitive? Then examples/hello_embed.rs and examples/ mini_repl.rs may be of some assistance. Disclaimer RustPython is in development, and while the interpreter certainly can be used in interesting use cases like running Python in WASM and embedding into a Rust project, do note that RustPython is not totally production-ready. Contribution is more than welcome! See our contribution section for more information on this. Conference videos Checkout those talks on conferences: * FOSDEM 2019 * EuroPython 2018 Use cases Although RustPython is a fairly young project, a few people have used it to make cool projects: * GreptimeDB: an open-source, cloud-native, distributed time-series database. Using RustPython for embedded scripting. * pyckitup: a game engine written in rust. * Robot Rumble: an arena-based AI competition platform * Ruff: an extremely fast Python linter, written in Rust Goals * Full Python-3 environment entirely in Rust (not CPython bindings) * A clean implementation without compatibility hacks Documentation Currently along with other areas of the project, documentation is still in an early phase. You can read the online documentation for the latest release, or the user guide. You can also generate documentation locally by running: cargo doc # Including documentation for all dependencies cargo doc --no-deps --all # Excluding all dependencies Documentation HTML files can then be found in the target/doc directory or you can append --open to the previous commands to have the documentation open automatically on your default browser. For a high level overview of the components, see the architecture document. Contributing Contributions are more than welcome, and in many cases we are happy to guide contributors through PRs or on Discord. Please refer to the development guide as well for tips on developments. With that in mind, please note this project is maintained by volunteers, some of the best ways to get started are below: Most tasks are listed in the issue tracker. Check issues labeled with good first issue if you wish to start coding. To enhance CPython compatibility, try to increase unittest coverage by checking this article: How to contribute to RustPython by CPython unittest Another approach is to checkout the source code: builtin functions and object methods are often the simplest and easiest way to contribute. You can also simply run ./whats_left.py to assist in finding any unimplemented method. Compiling to WebAssembly See this doc Community Discord Banner Chat with us on Discord. Code of conduct Our code of conduct can be found here. Credit The initial work was based on windelbouwman/rspython and shinglyu/ RustPython Links These are some useful links to related projects: * https://github.com/ProgVal/pythonvm-rust * https://github.com/shinglyu/RustPython * https://github.com/windelbouwman/rspython License This project is licensed under the MIT license. Please see the LICENSE file for more details. The project logo is licensed under the CC-BY-4.0 license. Please see the LICENSE-logo file for more details. About A Python Interpreter written in Rust rustpython.github.io Topics language rust interpreter compiler wasm jit python3 hacktoberfest python-language Resources Readme License MIT, CC-BY-4.0 licenses found Licenses found MIT LICENSE CC-BY-4.0 LICENSE-logo Code of conduct Code of conduct Activity Custom properties Stars 18.2k stars Watchers 167 watching Forks 1.2k forks Report repository Releases 5 tags Packages 0 No packages published Used by 847 * @jennifertrin * @Luzzotica * @kimathikim * @gam3du * @eddoss * @amiiiiii830 * @MolotovCherry * @amiiiiii830 + 839 Contributors 384 * @youknowone * @coolreader18 * @windelbouwman * @fanninpm * @palaviv * @DimitrisJim * @cthulahoops * @qingshi163 * @OddCoincidence * @Snowapril * @moreal * @deantvv * @OddBloke * @ChJR + 370 contributors Languages * Rust 84.3% * Python 14.7% * JavaScript 0.7% * EJS 0.1% * CSS 0.1% * Shell 0.1% Footer (c) 2024 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.