Installation¶
本パッケージは Python 3.10〜3.12 に対応しています。
📦 PyPI からのインストール¶
PyPI から直接インストールする場合は、以下のコマンドを実行してください。
以下のコマンドでYomiToku-Clientが実行できます。
⚡ uv を使用したインストール¶
本リポジトリは、次世代の高速パッケージ管理ツール uv を採用しています。
🚀 1. コマンドラインからの単体実行¶
YomiToku-Clientのコマンド単体で使う場合は以下のようにuvxを付けて実行できます。
初回実行時にパッケージがインストールされ、二回目以降の実行時はキャッシュが利用されます。
💻 2. Pythonプロジェクトへの組み込み¶
PythonのスクリプトにYomiToku-Clientを組み込みたい場合はuv initなどでpyproject.tomlを作成し、以下のコマンドを実行します。
依存関係が自動的に解決・インストールされます。
🧑💻 開発者向けセットアップ¶
開発環境を構築する場合は、リポジトリをクローンし、開発用依存関係も含めて同期します。
本プロジェクトでは、ジョブランナーとして tox を使用しています。 以下のコマンドで tox をインストールしてください。
🔧 tox コマンド例¶
tox により、Lint チェック・フォーマット・テストを一元管理しています。
# 各Pythonバージョンでユニットテストを実行
tox -p -e py310,py311,py312
# コードフォーマッタの適用 (ruff format)
tox -e format
# Linterチェックと自動修正 (ruff check --fix)
tox -e lint
🪄 pre-commit の設定¶
コミット時に自動で linter / formatter を適用するために、
pre-commit フックをインストールします。
これにより、コミット前に Ruff などの静的解析・整形処理が自動実行されます。
📄 ドキュメントのサービング¶
ドキュメントはmkdocsを利用して、作成しています。以下のコマンドを実行して、ローカルホストにサービングし、ドキュメントの内容を確認できます。