基本
Ryeを使用するには、pyproject.tomlベースのPythonプロジェクトが必要です。このガイドでは、rye initを使用して新しいフォルダと新しいプロジェクトを作成することができます。
rye init my-project
cd my-project
以下の構造が作成されます
.
├── .git
├── .gitignore
├── .python-version
├── README.md
├── pyproject.toml
└── src
└── my_project
└── __init__.py
知っておくと良いこと
initコマンドは、生成する内容をカスタマイズするための多くのオプションを受け入れます。インストールされているバージョンで使用可能なすべてのオプションを表示するには、rye init --helpを実行してください。
pyproject.tomlは、プロジェクトに関するメタデータと、いくつかのRye設定を保存するために使用されます。Ryeのほとんどのコマンドは、動作するためにpyproject.tomlが必要です。現在、Ryeはsetup.pyベースのプロジェクトをサポートしていないことに注意してください。Ryeがプロジェクトを初期化するとき、.python-versionファイルも書き込むことに注意してください。このファイルには、このプロジェクトで使用する必要があるPythonのバージョンの番号が含まれています。これはrye pinを実行することで変更できます。たとえば、RyeにPython 3.10を使用するように指示するには、次のようにします。
$ rye pin 3.10
最初の同期
完了したら、rye syncを使用して最初の同期を取得できます。その後、Ryeは.venvに仮想環境を作成し、ロックファイルをrequirements.lockとrequirements-dev.lockに書き込みます。
rye sync
Ryeが管理する仮想環境は、pyproject.tomlの隣の.venvに配置されます。これを初めて実行すると、Ryeが互換性のあるCPythonインタープリターを自動的にダウンロードしてインストールしたことがわかります。システムに別のPythonインストールがすでにある場合、それは使用されません！ この動作の詳細については、ツールチェーンについて読む。
注目すべき例外が1つありますが、通常どおりアクティブにして使用できます。その中のPythonインストールにはpipが含まれていません。シムを有効にしてRyeを正しくインストールした場合、同期後にpythonを実行すると、有効になっていなくても、自動的にその仮想環境で操作されます。 sys.prefixを出力することで、これを検証できます。
python -c "import sys; print(sys.prefix)"
管理対象の仮想環境へのフルパスが出力されます。
依存関係の追加
addコマンドを使用して、プロジェクトに依存関係を追加します。
rye add "flask>=2.0"
続いてrye syncを実行して、依存関係を仮想環境にインストールします。カスタムインデックスからパッケージを追加する場合は、最初にソースを設定する必要があります。
依存関係のリスト表示
rye listを呼び出すと、プロジェクトのすべてのインストール済み依存関係のダンプを取得できます。これは実際にインストールされている依存関係のみをリストするため、最初にsyncを実行してください。
rye list
依存関係の削除
removeコマンドを使用して、プロジェクトから依存関係を再び削除します。
rye remove flask
プロジェクトでの作業
仮想環境のコンテキストで実行可能ファイルを実行するには、runコマンドを使用します。たとえば、blackを使用するには、プロジェクトに追加し、仮想環境を同期し、次のようにカレントディレクトリで実行します。
rye add black
rye sync
rye run black .
コマンドを直接使用できるようにするには、通常どおり仮想環境をアクティブにする必要があります。仮想環境をアクティブにするには、標準の方法を使用します
. .venv/bin/activate
.venv\Scripts\activate
再び非アクティブ化するには、deactivateを実行します
deactivate
プロジェクトの検査
rye showコマンドは、プロジェクトの状態に関する情報を出力できます。 rye showを実行するだけで、どのPythonバージョンが使用されているか、仮想環境がどこにあるかなどを確認できます。
rye show
実行可能なプロジェクト
実行可能なスクリプトを提供することを目的としたプロジェクトを生成するには、rye init --scriptを使用します
rye init --script my-project
cd my-project
以下の構造が作成されます
.
├── .git
├── .gitignore
├── .python-version
├── README.md
├── pyproject.toml
└── src
└── my_project
└── __init__.py
└── __main__.py
pyproject.tomlは、__init__.pyのmain()関数を指すmy-projectスクリプトを含む[project.scripts]セクションで生成されます。変更を同期した後、rye run my-projectでスクリプトを実行できます。
rye sync
rye run my-project