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
To set up a local development environment, begin by cloning the repository:
114
+
To set up a local development environment, we recommend using `uv`, which can be installed following their [instructions](https://docs.astral.sh/uv/getting-started/installation/).
115
+
116
+
Once `uv` has been installed, begin by cloning the repository:
Once in root level of the repository, install the dependencies using a package manager of your choice:
123
+
Once in root level of the repository, create a new virtual environment and install the project dependencies.
122
124
123
125
```bash
124
-
# pip
125
-
python -m venv .venv
126
-
source .venv/bin/activate
127
-
pip install ".[dev, examples]"
128
-
129
-
# uv
130
126
uv venv
131
-
source .venv/bin/activate
127
+
# uv venv --python 3.11 # use this instead if you need a specific python version
128
+
129
+
source .venv/bin/activate # command may differ based on your shell
132
130
uv pip install ".[dev, examples]"
133
131
```
134
132
135
133
Once the dependencies have been installed, install pre-commit and set up the git hook scripts:
136
134
137
135
```bash
138
-
# pip
139
-
pip install pre-commit
140
-
141
-
# uv
142
136
uv pip install pre-commit
143
-
144
-
# Install git hook scripts
145
137
pre-commit install
146
138
```
147
139
140
+
If you would like more information regarding the uv commands, please refer to uv's documentation for more information on their [pip interface](https://docs.astral.sh/uv/pip/).
141
+
148
142
### Developments scripts
149
143
150
144
To build the documentation locally, simply execute the following commands from project root (only for Unix):
0 commit comments