A brief description of your project.
This section describes how to set up a development environment using uv.
uv is a fast Python package installer and resolver, written in Rust. You can install it by running one of the following commands in your terminal:
Using curl:
curl -LsSf https://astral.sh/uv/install.sh | shOr, if you have pip installed:
pip install uvFor other installation methods, please refer to the official uv documentation.
Once uv is installed, navigate to the root of this repository and run the setup script:
sh setup_uv_env.shThis script will:
- Create a virtual environment named
.venvin the project root. - Activate the virtual environment.
- Install all necessary dependencies from
requirements.txt. - Install all development dependencies from
requirements-dev.txt.
After the script completes, the virtual environment .venv will be created. To activate it in your current terminal session, run:
source .venv/bin/activateYou should now see (.venv) at the beginning of your terminal prompt, indicating that the virtual environment is active. You can now run the application and development tools.
To deactivate the virtual environment, simply run:
deactivate(You can add other sections here, like "Usage", "Running Tests", "Deployment", etc.)