Rye でパッケージ管理をするためのコマンドや説明などのメモ

概要

Python のパッケージ管理とバージョン管理ができるRyeを使って Python のパッケージ管理をするときに使用するコマンドなどをまとめました。

• 参考： Rye の公式ドキュメント

インストールや環境構築の手順などはこちら

パッケージ構築

init <パッケージ名>

Rye を使って新しいパッケージを初期化します

rye init <パッケージ名>

• 作成例

  rye init my-project
  

  新しくmy-projectという名前のパッケージが作成され、次のようなディレクトリ構造が生成されます
  pyproject.tomlにパッケージの情報が記録されていきます

  my-project
  ├── .git
  ├── .gitignore
  ├── .python-version
  ├── README.md
  ├── pyproject.toml
  └── src
      └── my_project
          └── __init__.py
  

pin <任意のバージョン>

パッケージ内で使用される Python のバージョンをinitで生成されたものから任意のものに指定できます

• .python-versionが上書きされます

pin <任意のバージョン>

• 使用例

  rye pin cpython@3.13
  

sync

pyproject.tomlの内容に基づいて仮想環境を構築します

• パッケージのディレクトリに.venvフォルダが生成されます
• requirements.lockとrequirements-dev.lockの 2 つのファイルが生成されます

rye sync

ライブラリの管理

add <ライブラリ名>

パッケージにライブラリを追加します

• pyproject.tomlに追加されます

 rye add <ライブラリ名>

add --dev <ライブラリ名>

開発時にのみ使用するライブラリを追加します

• pyproject.tomlに追加され、requirements-dev.txtにも追加されます

 rye add  --dev <ライブラリ名>

• 追加例
  • rye add --dev pyinstaller

list

パッケージに追加されているライブラリを一覧します

rye list

remove <ライブラリ名>

パッケージからライブラリを削除します

 rye remove <ライブラリ名>

パッケージの管理

show

現在のパッケージの情報を表示します

rye show

仮想環境の有効化/無効化

通常のように仮想環境の操作もできます
仮想環境を有効化することで、インストールされたライブラリをパッケージ内で使用することなどもできます

.venv\Scripts\activate

仮想環境の有効化

.\venv\Scripts\activate

deactivate

仮想環境の無効化

 deactivate