パッケージ管理ツールryeの使い方

作成日:2023-11-25 更新日:2024-11-03
Python

Pythonにはpipenvやpoetryなどのパッケージ管理ツールがありますが、今回はryeを利用します。 ryeはrustで書かれているパッケージ管理ツールで、pipenvやpoetryと比べて手軽にPythonのバージョンやパッケージ管理できるのが特徴です。 また、仮想環境として作成されるので、プロジェクト間でパッケージの衝突を気にする必要がありません。

インストール

ryeはhomebrewでインストールできます。

brew install rye

Linuxの場合は以下のコマンドでインストールします。

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

プロジェクトの初期化

プロジェクト名を入れて初期化します。

rye init <project_name>

既存のディレクトリに初期化したい場合は.をプロジェクト名に指定します。

Pythonのバージョン指定

何も指定せずに実行した場合、Pythonのバージョンは基本的にcpythonの最新バージョンになります。 ライブラリの都合上特定のバージョンにしたい場合は以下のコマンドを実行します。

rye pin 3.10.12

このコマンドはcpythonのバージョンを指定するものです。 他のPyPyなどのバージョンを指定したい場合はpypy@3.10.12と指定する必要があります。

自分の環境で利用できるバージョンは以下のコマンドで確認できます。

rye toolchain list --include-downloadable

パッケージの追加(更新)・削除

パッケージを追加するにはaddコマンドを利用します。 パッケージ名は複数指定することができ、スペース区切りで指定します。

パッケージを更新する際も同様にaddコマンドを利用します。

rye add <package_name> <package_name>

パッケージを追加するだけではインストールされないので、syncコマンドを実行してインストールします。

rye sync

削除したい場合はremoveコマンドを利用します。

rye remove <package_name>

パッケージをグローバルにインストールしたい場合(例:フォーマッタやリンタ)installコマンドを利用します。

rye install <package_name>

プログラムの実行

作成したPythonのプログラムはryeを利用して実行します。

rye run python main.py

タスクの登録

コマンドが長く何度も利用する場合はpyproject.tomlにタスクを登録することができます。

[tool.rye.scripts]
main = "python main.py"

登録したタスクは以下のコマンドで実行できます。

rye run main