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: README.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,26 @@ A majority of the code is generated in the `codegen/` upon first compile and thr
10
10
11
11
This includes the code generated by `flatc` (living in `src/generated`), the Python wrapper binds to the generated Rust code, and the Python type hints (`rlbot_flatbuffers.pyi`).
12
12
13
+
### Dev setup
14
+
15
+
- Ensure Python 3.11+ is installed
16
+
- Create a virtual Python environment
17
+
-`python3 -m venv venv`
18
+
- Activate the virtual environment
19
+
- Windows: `venv\Scripts\activate.bat`
20
+
- Linux: `source venv/bin/activate`
21
+
- Install maturin
22
+
-`pip install maturin`
23
+
- Build & install for testing
24
+
-`maturin develop --release`
25
+
26
+
To use in another Python environment, like if testing [python-interface](https://github.com/VirxEC/python-interface/blob/master/README.md?plain=1), you can build the wheel:
27
+
28
+
-`maturin build --release`
29
+
- (In another environment) `pip install path/to/file.whl`
30
+
31
+
The exact path of the wheel will be printed by maturin, just copy+paste it.
32
+
13
33
### Basic usage
14
34
15
35
All classes and methods should have types hints readable by your IDE, removing the guesswork of common operations.
0 commit comments