rye - A comprehensive Python project and package management solution.

rye

A comprehensive Python project and package management solution.

Introduction

rye is a Python project and package management solution written in Rust by astral-sh. It's a comprehensive and modern solution that integrates Python version management, automated dependency management, Python package management, automated virtual environment management, project initialization, Python linting, and more. It's suitable for medium to large-scale projects or teams.

Relationship between rye, uv, and ruff: They are all modern Python development tools developed by the astral-sh team. The astral-sh team's vision is to release a "final version" of rye that calls tools like uv and ruff under the hood, providing a unified interface for managing Python projects. (When necessary, Python projects supported by rye can be directly migrated to uv)

Quick Start

1. Install and start rye:

   eval "$(curl https://get.x-cmd.com)"        # Install x-cmd
   x env use rye                               # Use x-cmd to install rye

2. Quickly set up a Python project environment:

   • The default global installation directory for rye is the .rye directory in the user's home directory.
   • rye toolchain: Used to download and manage Python. rye defines different versions of Python as different Python toolchains and manages them accordingly.
   • rye init: Initialize new or existing Python projects. Compared to uv init, rye init provides a more comprehensive initialization with a more standardized project directory structure.
   • rye add: Download dependencies and add them to the project. Compared to uv add, rye add uses a more relaxed but more universal and portable lock file.
   • rye list: View downloaded project dependencies. Compared to uv tree, rye list is more concise, only listing the package names and version numbers, similar to pip list.
   • rye remove: Remove dependencies from the project.

3. Manage and run Python projects:

   • rye run: Run commands provided by Python packages in the current project. Note that this command differs significantly from uv run and uvx, don't confuse them. For details, refer to the official documentation for rye and uv.
   • rye tools install: Install Python applications in the global environment. The installation location is the .rye/tools directory in the user's home directory, with corresponding shim files located in the .rye/shims directory.
   • rye fmt/lint: Check or format Python code in the project.
   • rye build: Build packages for distribution.
   • rye publish: Publish packages to a package repository.

Features

1. Built-in Python version management: Automatically download and manage multiple versions of Python, with automatic switching.
2. Comprehensive functionality and easy to use: Integrates common features in the Python project development process, such as dependency management, virtual environment management, Python linting, testing, packaging, and publishing.
3. Good compatibility: Manages projects based on pyproject.toml, seamlessly integrating with existing Python projects and tools.

Competitors and Related Projects

1. ruff: A modern Python code checking tool developed by the Astral-sh team, characterized by fast speed, support for multiple languages, and multiple frameworks.
2. uv: A modern Python project management tool developed by the Astral-sh team, fast and capable of replacing tools like pip, pip-tools, pipx, poetry, pyenv, virtualenv, etc.
3. poetry: A modern Python project dependency management and packaging tool developed by the python-poetry team, one of the most popular Python project management tools currently.

Further Reading

• rye GitHub - The source code for the rye project is hosted on GitHub, where you can find the latest version of rye and participate in community contributions.
• rye Official Documentation - The official documentation for rye provides detailed guides and references, including basic concepts and command usage for rye.

Global Installation：

1. Automatically download the installation package and expand it locally.
2. Automatically create symbolic links for executable files in x-cmd's bin directory.
3. All currently open shells can directly use the command name.

x pkg use rye

https://github.com/astral-sh/rye
License	MIT
Language	"Rust"
Version	v0.43.0 stable

Package Installation Support Provided for
x64
	Linux
	Darwin
	Windows
ARM64
	Linux
	Darwin

Package Binary Source from

Repackaged from Official Source
• https://github.com/x-cmd-build/rye/releases

Related Link

Module

`x pkg` => usage