Rye is not a necesary dependency but does make it much simpler. You can still create a virtual environment and install using the
requirements.lockfile
This project uses Rye for dependency management. Follow these steps to set up the project:
Instructions for installation on windows are on the Rye site
-
Install Rye if you haven't already (this is for MacOS):
curl -sSf https://rye.astral.sh/get | bash -
Clone the repository (or git pull if you've already cloned):
-
Install dependencies using Rye:
rye sync
This will create a virtual environment and install all the required dependencies specified in the pyproject.toml file.
Mac OS: 4. Activate the virtual environment (from main dir):
. .venv/bin/activate
Windows OS: 4. Open Windows PowerShell (Admin): Press
Ctr + X
Then select Windows PowerShell (Admin)
- Check if you have permission to run scripts:
Get-ExecutionPolicy
Then press enter
If you get the output
RemoteSigned
skip the next step
-
Allow system to run scripts:
Set-ExecutionPolicy RemoteSignedThen press enter and type Y to confirm change
-
Activate the virtual environment (from main dir):
.\.venv\Scripts\activate