As developers, managing virtual environments is a crucial part of our workflow. With Python projects constantly shifting between dependencies and Python versions, using tools that streamline this process is key. Enter In this post, I\u2019ll introduce you to By using Managing Python projects often involves juggling various dependencies, versions, and configurations. Without proper tooling, this can become a headache. In our examples, before each command you will see our shell prompt:<\/p>\n\n\n\n Don’t type the \u276f when you enter the command. So, when seeing<\/p>\n\n\n\n just type<\/p>\n\n\n\n In addition, when we activate the virtual environment, you will see a changed prompt:<\/p>\n\n\n\n Getting started with With MacOS or Linux, you can install uv from the website:<\/p>\n\n\n\n Alternatively, you can install Once installed, you can use This command will create a new virtual environment inside the After creating the virtual environment, you can easily activate it using the following command:<\/p>\n\n\n\n No need to worry about different activation scripts for Windows, Linux, or macOS. Once the environment is active, you can install your project’s dependencies as you normally would:<\/p>\n\n\n\n You can also switch to a First you have to initialize the project:<\/p>\n\n\n\n Then, add the dependency:<\/p>\n\n\n\n When you create a virtual environment, the corresponding folder should be in your PATH.<\/p>\n\n\n\n Normally this is But, if you want to choose a different folder, you must set the variable UV_PROJECT_ENVIRONMENT to this path:<\/p>\n\n\n\n So, with the default settings, you will get an error because uv is searching the virtual environment in .venv.<\/p>\n\n\n\n Use the environment variable to tell uv where the virtual environment is installed.<\/p>\n\n\n\n Use Here are a few more useful uv<\/code><\/strong>: a tool designed to simplify the creation, activation, and management of virtual environments and to manage python packages and projects.<\/p>\n\n\n\nuv<\/code>, walk you through its installation, and provide some tips to help you get started.<\/p>\n\n\n\nWhat is
uv<\/code>?<\/h2>\n\n\n\nuv<\/a><\/code> is an extremely fast Python package and project manager, written in Rust. It is a powerful tool that allows developers to manage Python virtual environments effortlessly. It provides functionality to create, activate, and switch between virtual environments in a standardized way. <\/p>\n\n\n\nuv<\/code>, you can ensure that your virtual environments are consistently created and activated across different projects without the need to manually deal with multiple commands.<\/p>\n\n\n\nWhy Use
uv<\/code>?<\/h2>\n\n\n\nuv<\/code><\/strong> helps by:<\/p>\n\n\n\n\n
Hint<\/h2>\n\n\n\n
\u276f <\/pre>\n\n\n\n
\u276f uv init<\/pre>\n\n\n\n
uv init<\/pre>\n\n\n\n
\u2726 \u276f <\/pre>\n\n\n\n
Installation and Setup<\/h2>\n\n\n\n
uv<\/code> is easy. Below are the steps for installing and setting up uv<\/code> for your Python projects.<\/p>\n\n\n\n1. Install
uv<\/code><\/h3>\n\n\n\n\u276f curl -LsSf https:\/\/astral.sh\/uv\/install.sh | sh<\/pre>\n\n\n\n
uv<\/code> using pip<\/code>. You\u2019ll need to have Python 3.8+<\/strong> installed on your system.<\/p>\n\n\n\n\u276f pip install uv<\/pre>\n\n\n\n
2. Create a New Virtual Environment<\/h3>\n\n\n\n
uv<\/code> to create a virtual environment for your project. Simply navigate to your project directory and run:<\/p>\n\n\n\n\u276f uv new<\/pre>\n\n\n\n
.venv<\/code> folder within your project.<\/p>\n\n\n\n3. Activate the Virtual Environment<\/h3>\n\n\n\n
uv activate<\/pre>\n\n\n\n
uv<\/code> handles that for you.<\/p>\n\n\n\n4. Install Your Dependencies<\/h3>\n\n\n\n
\u276f pip install -r requirements.txt<\/pre>\n\n\n\n
uv<\/code> ensures that your dependencies are installed in the correct environment without any extra hassle.<\/p>\n\n\n\npyproject.toml<\/code> file to manage your dependencies.<\/p>\n\n\n\n\u276f uv init<\/pre>\n\n\n\n
\u276f uv add requests<\/pre>\n\n\n\n
Tips with virtual environments<\/h3>\n\n\n\n
.venv\/bin<\/code>, when you create it with uv init<\/code>. This path is added to your $PATH variable when you run uv activate.<\/code><\/p>\n\n\n\n\u276f mkdir playground\n\u276f cd playground\n\u276f \/usr\/local\/bin\/python3.12 -m venv .venv\/python\/3.12\n\u276f . .venv\/python\/3.12\/bin\/activate\n\n\u2726 \u276f which python\n...\/Playground\/.venv\/python\/3.12\/bin\/python\n\n\u2726 \u276f export UV_PROJECT_ENVIRONMENT=$PWD\/.venv\/python\/3.12<\/pre>\n\n\n\n
\u2726 \u276f pip install uv\nCollecting uv\n Downloading uv-0.4.25-py3-none-macosx_10_12_x86_64.whl.metadata (11 kB)\nDownloading uv-0.4.25-py3-none-macosx_10_12_x86_64.whl (13.2 MB)\n \u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501 13.2\/13.2 MB 16.5 MB\/s eta 0:00:00\nInstalling collected packages: uv\nSuccessfully installed uv-0.4.25\n\n\u2726 \u276f which uv\n...\/Playground\/.venv\/python\/3.12\/bin\/uv<\/pre>\n\n\n\n
\u2726 \u276f uv init\nInitialized project `playground`<\/pre>\n\n\n\n
\u2726 \u276f uv add requests\nwarning: `VIRTUAL_ENV=.venv\/python\/3.12` does not match the project environment path `...\/.venv\/python\/3.12` and will be ignored<\/pre>\n\n\n\n
\u2726 \u276f export UV_PROJECT_ENVIRONMENT=$PWD\/.venv\/python\/3.12\n\n\u2726 \u276f uv add requests\nResolved 6 packages in 0.42ms\nInstalled 5 packages in 8ms\n + certifi==2024.8.30\n + charset-normalizer==3.4.0\n + idna==3.10\n + requests==2.32.3\n + urllib3==2.2.3<\/pre>\n\n\n\n
Tip<\/h2>\n\n\n\n
direnv<\/code> to automatically set your environment:<\/p>\n\n\n\n\n
\n
.envrc <\/code>file:<\/li>\n<\/ul>\n\n\n\n\u2726 \u276f . .venv\/python\/3.12\/bin\/activate\n\u2726 \u276f export UV_PROJECT_ENVIRONMENT=$PWD\/.venv\/python\/3.12<\/pre>\n\n\n\n
\n
\u2726 \u276f direnv allow<\/pre>\n\n\n\n
Common
uv<\/code> Commands<\/h3>\n\n\n\nuv<\/code> commands to keep in mind:<\/p>\n\n\n\n\n
uv deactivate<\/code><\/li>\n\n\n\nuv remove<\/code><\/li>\n\n\n\nuv list<\/code><\/li>\n<\/ul>\n\n\n\nTips for Using
uv<\/code> Effectively<\/h3>\n\n\n\n\n
uv<\/code> uses .venv<\/code> as the folder name for virtual environments. Stick to this default to keep things consistent across your projects.<\/li>\n\n\n\nuv<\/code> into your CI\/CD pipeline<\/strong>: Ensure that your automated build tools use the same virtual environment setup by adding uv<\/code> commands to your pipeline scripts.<\/li>\n\n\n\nuv<\/code> in combination with pyproject.toml<\/code><\/strong>: If your project uses pyproject.toml<\/code> for dependency management, uv<\/code> can seamlessly integrate, ensuring your environment is always up to date.<\/li>\n\n\n\nuv<\/code>‘s environment activation and deactivation commands make it easy to switch between projects without worrying about which virtual environment is currently active.<\/li>\n\n\n\nuv<\/code> with direnv<\/code> or add an activation hook in your shell to automatically activate the correct environment when you enter a project folder.<\/li>\n<\/ol>\n\n\n\nCheatsheet<\/h2>\n\n\n\n
uv<\/code> Command Cheatsheet<\/h2>\n\n\n\nGeneral Commands<\/h3>\n\n\n\n