readme

Author: marcomq

README.md

@@ -1,23 +1,25 @@
 # async_py
 
-A Rust library for calling Python code asynchronously using `pyo3` and `tokio`.
+A Rust library for calling Python code asynchronously using [pyo3](https://github.com/PyO3/pyo3) and [tokio](https://tokio.rs/).
 
-This library provides a `PyRunner` that runs a Python interpreter in a dedicated background thread. Global variables will be kept and stored in this runner. 
-You can send Python code to this executor from any async Rust task, and it will be executed without blocking your application.
+This library provides a `PyRunner` that runs a Python interpreter in a dedicated 
+background thread. Global variables are preserved within the runner's scope. 
+You can send Python code to this executor from any async Rust task, 
+and it will be executed without blocking your application.
 
-Due to the Python global interpreter lock (GIL), there will not be any multithreading. If one python
+Due to the Python Global Interpreter Lock (GIL), you cannot run Python code simultaneously. If one Python
 task is performing a computation or a sleep, no other task can access the interpreter.
 
-Using multiple `PyRunner` does not allow multithreading, due to the architecture 
-of python. But you can isolate your global variables by using multiple runners.
+Using multiple `PyRunner` instances does not enable simultaneous Python code execution due to the GIL. 
+However, it does allow you to isolate global variables between different runners.
 
 ## Usage
 
 Add `async_py` to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-async_py = { git = "..." } # Or path, or crates.io version
+async_py = { git = "https://github.com/marcomq/async_py" } # Or path, or crates.io version
 tokio = { version = "1", features = ["full"] }
 ```
 
@@ -48,3 +50,24 @@ def greet(name):
     println!("{}", result2.as_str().unwrap()); // Prints: Hello World! Called 2 times from Python.
 }
 ```
+### Using a venv
+It is generally recommended to use a venv to install pip packages.
+While you cannot switch the interpreter version with this crate, you can use an
+existing venv to load installed packages.
+
+```rust
+let runner = PyRunner::new();
+runner.set_venv(&Path::new("/path/to/venv")).await?;
+```
+
+### rustpython
+PyO3 has usually the best compatibility for python packages.
+But if you want to use python on android, wasm, or if you don't want to use any
+external library, you can use [rustpython](https://github.com/RustPython/RustPython).
+Keep in mind that some essential packages like `os` are missing on rustpython.
+
+Cargo.toml
+```toml
+[dependencies]
+async_py = { features = ["rustpython"] } 
+```