Skip to content

Commit e01add5

Browse files
authored
Merge pull request #2087 from aviramha/contributing_improvements
Add setting up a dev environment notes
2 parents be70e54 + 47993e1 commit e01add5

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

Contributing.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,17 @@ You can browse the API of the non-public parts of PyO3 [here](https://pyo3.rs/in
1515

1616
The following sections also contain specific ideas on where to start contributing to PyO3.
1717

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+
1829
### Help users identify bugs
1930

2031
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

Comments
 (0)