https://github.com/astral-sh/rye

a Hassle-Free Python Experience
https://github.com/astral-sh/rye

package-manager packaging python

Last synced: 3 days ago
JSON representation

a Hassle-Free Python Experience

• Host: GitHub
• URL: https://github.com/astral-sh/rye
• Owner: astral-sh
• License: mit
• Created: 2023-04-22T22:23:54.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-29T00:25:04.000Z (about 1 month ago)
• Last Synced: 2024-10-29T11:24:49.364Z (about 1 month ago)
• Topics: package-manager, packaging, python
• Language: Rust
• Homepage: https://rye.astral.sh
• Size: 3.22 MB
• Stars: 13,781
• Watchers: 60
• Forks: 468
• Open Issues: 324
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome - astral-sh/rye - a Hassle-Free Python Experience (Rust)
• jimsghstars - astral-sh/rye - a Hassle-Free Python Experience (Rust)

README

        


  

  
Rye: a Hassle-Free Python Experience



----



[![Rye](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/rye/main/artwork/badge.json)](https://rye.astral.sh)

[![](https://dcbadge.vercel.app/api/server/drbkcdtSbg?style=flat)](https://discord.gg/drbkcdtSbg)



> [!NOTE]

>

> If you're getting started with Rye, consider [uv](https://github.com/astral-sh/uv), the

> [successor project](https://lucumr.pocoo.org/2024/2/15/rye-grows-with-uv/) from the same maintainers.

> 

> While Rye is actively maintained, uv offers a more stable and feature-complete experience, and is the recommended

> choice for new projects.

> 

> Having trouble migrating? [Let us know what's missing.](https://github.com/astral-sh/rye/discussions/1342)

Rye is a comprehensive project and package management solution for Python.

Born from [its creator's](https://github.com/mitsuhiko) desire to establish a

one-stop-shop for all Python users, Rye provides a unified experience to install and manage Python

installations, `pyproject.toml` based projects, dependencies and virtualenvs

seamlessly.  It's designed to accommodate complex projects, monorepos and to

facilitate global tool installations.  Curious? [Watch an introduction](https://youtu.be/q99TYA7LnuA).

A hassle-free experience for Python developers at every level.



  

    

  

  
Click on the thumbnail to watch a 16 minute introduction video



## In The Box

Rye picks and ships the right tools so you can get started in minutes:

* **Bootstraps Python:** it provides an automated way to get access to the amazing [Indygreg Python Builds](https://github.com/indygreg/python-build-standalone/) as well as the PyPy binary distributions.

* **Linting and Formatting:** it bundles [ruff](https://github.com/astral-sh/ruff) and makes it available with `rye lint` and `rye fmt`.

* **Managing Virtualenvs:** it uses the well established virtualenv library under the hood.

* **Building Wheels:** it delegates that work largely to [build](https://pypi.org/project/build/).

* **Publishing:** its publish command uses [twine](https://pypi.org/project/twine/) to accomplish this task.

* **Locking and Dependency Installation:** is today implemented by using [uv](https://github.com/astral-sh/uv) with a fallback to [unearth](https://pypi.org/project/unearth/) and [pip-tools](https://github.com/jazzband/pip-tools/).

* **Workspace support:** Rye lets you work with complex projects consisting

  of multiple libraries.

## Installation

The installation takes just a minute:

* **Linux and macOS:**

    ```

    curl -sSf https://rye.astral.sh/get | bash

    ```

* **Windows:**

    Download and run the installer ([64-bit (x86-64)](https://github.com/astral-sh/rye/releases/latest/download/rye-x86_64-windows.exe) or [32-bit (x86)](https://github.com/astral-sh/rye/releases/latest/download/rye-x86-windows.exe)).

For more details and other options, refer to the [installation instructions](https://rye.astral.sh/guide/installation/).

## Learn More

Did I spark your interest?

* [Visit the Website](https://rye.astral.sh/)

* [Read the Documentation](https://rye.astral.sh/guide/)

* [Report Problems in the Issue Tracker](https://github.com/astral-sh/rye/issues)

## More

* [Discussion Forum](https://github.com/astral-sh/rye/discussions), to discuss the project

  on GitHub

* [Discord](https://discord.gg/drbkcdtSbg), for conversations with other developers in text form

* [Issue Tracker](https://github.com/astral-sh/rye/issues), if you run into bugs or have suggestions

* [Badges](https://rye.astral.sh/community/#badges), if you want to show that you use Rye

* License: MIT