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
Copy file name to clipboardExpand all lines: Contributing.md
+11Lines changed: 11 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -15,6 +15,17 @@ You can browse the API of the non-public parts of PyO3 [here](https://pyo3.rs/in
15
15
16
16
The following sections also contain specific ideas on where to start contributing to PyO3.
17
17
18
+
## Setting up a development environment
19
+
20
+
To work and develop PyO3, you need Python & Rust installed on your system.
21
+
* We encourage the use of [rustup](https://rustup.rs/) to be able to select and choose specific toolchains based on the project.
22
+
*[Pyenv](https://github.com/pyenv/pyenv) is also highly recommended for being able to choose a specific Python version.
23
+
*[virtualenv](https://virtualenv.pypa.io/en/latest/) can also be used with or without Pyenv to use specific installed Python versions.
24
+
25
+
### Caveats
26
+
27
+
* When using pyenv on macOS, installing a Python version using `--enable-shared` is required to make it work. i.e `env PYTHON_CONFIGURE_OPTS="--enable-shared" pyenv install 3.7.12`
28
+
18
29
### Help users identify bugs
19
30
20
31
The [PyO3 Gitter channel](https://gitter.im/PyO3/Lobby) is very active with users who are new to PyO3, and often completely new to Rust. Helping them debug is a great way to get experience with the PyO3 codebase.
0 commit comments