rattler_installs_packages

Crates.iorattler_installs_packages
lib.rsrattler_installs_packages
version0.9.0
sourcesrc
created_at2023-12-08 13:26:56.127403
updated_at2024-04-23 08:46:32.474073
descriptionDatastructures and algorithms to interact with Python packaging ecosystem
homepagehttps://github.com/prefix-dev/rip
repositoryhttps://github.com/prefix-dev/rip
max_upload_size
id1062022
size1,840,312
Wolf Vollprecht (wolfv)

documentation

README

banner

RIP: Fast, barebones pip implementation in Rust

License Build Status Project Chat docs main

Introduction

RIP is a library that allows the resolving and installing of Python PyPI packages from Rust into a virtual environment. It's based on our experience with building Rattler and aims to provide the same experience but for PyPI instead of Conda.

What should I use this for?

Like Rattler, RIP should be fast and easy to use. This library is not a package manager itself but provides the low-level plumbing to be used in one. To see an example of this take a look at our package manager: pixi

RIP is based on the quite excellent work of posy and we have tried to credit the authors where possible.

Showcase

RIP has a very incomplete pip-like binary that can be used to test package installs. Let's resolve and install the flask python package. Running cargo r install flask /tmp/flask we get something like this:

rip-install

This showcases the downloading and caching of metadata from PyPI. As well as the package resolution using our incremental SAT solver: Resolvo, more on this below. Finally, after resolution it installs the package into a venv. We cache everything locally so that we can re-use the PyPi metadata.

Features

This is a list of current features of RIP, the biggest are listed below:

  • Async downloading and aggressive caching of PyPI metadata.
  • Resolving of PyPI packages using Resolvo.
  • Installation of wheel files.
  • Support sdist files (must currently adhere to the PEP 517 and PEP 518 standards).
  • Caching of locally built wheels.

More intricacies of the PyPI ecosystem need to be implemented, see our GitHub issues for more details.

Details

Resolving

We have integrated the stand-alone packaging SAT solver Resolvo, to resolve pypi packages. This solver is incremental and adds packaging metadata during resolution of the SAT problem. This feature can be enabled with the resolvo feature flag.

Installation

We have very simple installation support for the resolved packages. This should be used for testing purposes exclusively E.g. cargo r -- install flask /tmp/flask_env to create a venv and install the flask and it's into it. After which you can run:

  1. /tmp/flask_env/bin/python to start python in the venv.

  2. import flask #, this should import the flask package from the venv. There is no detection of existing packages in the venv yet, although this should be relatively straightforward.

Contributing 😍

We would love to have you contribute! See the CONTRIBUTING.md for more info. For questions, requests or a casual chat, we are very active on our discord server. You can join our discord server via this link.

Commit count: 203

cargo fmt