pandas開発にGitpodを使用する#
ドキュメントのこのセクションでは、以下の手順を説明します。
pandasの開発環境にGitpodを使用する
GitHub上のpandasリポジトリの個人フォークを作成する
pandasとVSCodeの簡単なツアー
Gitpodでのpandasドキュメントの作業
Gitpod#
Gitpodは、自動化され、すぐにコードを開始できる開発環境のためのオープンソースプラットフォームです。これにより、開発者は自分の開発環境をコードとして記述し、ブラウザから直接、新しいタスクごとに即時かつ新しい開発環境を開始できます。これにより、ローカル開発環境をインストールしたり、互換性のない依存関係に対処したりする必要が減ります。
Gitpod GitHub 統合#
Gitpodを使用するには、GitHubアカウントにGitpodアプリがインストールされている必要があります。まだアカウントをお持ちでない場合は、まずアカウントを作成する必要があります。
開始するには、Gitpodにログインし、GitHubに適切な権限を付与してください。
Python 3.10環境を構築し、環境が開始されるとすべての開発依存関係がインストールされます。
pandasリポジトリのフォーク#
コントリビューターとしてpandasで作業する最良の方法は、最初にリポジトリのフォークを作成することです。
GitHubのpandasリポジトリを参照し、独自のフォークを作成します。
自分のフォークを参照します。フォークにはnoatamir/pandas-devのようなURLが付与されます。ただし、
noatamirの代わりにGitHubのユーザー名が入ります。
Gitpodの起動#
GitHub経由でGitpodに認証したら、Gitpod ChromiumまたはFirefoxブラウザ拡張機能をインストールできます。これにより、リポジトリの**Code**ボタンの横に**Gitpod**ボタンが追加されます。
拡張機能をインストールした場合、**Gitpod**ボタンをクリックして新しいワークスペースを開始できます。
または、ブラウザ拡張機能をインストールしたくない場合は、https://gitpod.io/#https://github.com/USERNAME/pandasにアクセスし、
USERNAMEを自分のGitHubユーザー名に置き換えます。どちらの場合も、Webブラウザに新しいタブが開き、開発環境の構築が開始されます。これには数分かかる場合がありますのでご注意ください。
ビルドが完了すると、VSCodeエディターとpandasでの作業に必要なすべての依存関係を含むワークスペースに移動します。ワークスペースを初めて開始するときは、いくつかのアクションが実行されていることに気付くでしょう。これにより、pandasの開発バージョンがインストールされていることが保証されます。
ワークスペースの準備が完了したら、テストを実行するために、次のコマンドを入力します。
$ python -m pytest pandas
このコマンドの実行には時間がかかるため、実行されていることを確認したら、ctrl-cを使用してキャンセルすることができます。
ワークスペースのクイックツアー#
GitpodはエディターとしてVSCodeを使用します。以前にこのエディターを使用したことがない場合は、入門VSCodeドキュメントを確認して、慣れておいてください。
ワークスペースは以下の画像のような外観になります。
エディターの重要なセクションをいくつかマークしました。
現在のPythonインタープリター - デフォルトでは、これは
pandas-devであり、ステータスバーとターミナルに表示されます。常にアクティブ化されるため、conda環境をアクティブ化する必要はありません。現在のブランチは常にステータスバーに表示されます。このボタンを使用して、ブランチを変更または作成することもできます。
GitHub Pull Requests拡張機能 - これを使用してワークスペースからPull Requestを操作できます。
マーケットプレイス拡張機能 - pandas Gitpodに不可欠な拡張機能をいくつか追加しました。それでも、他の拡張機能や構文強調テーマをユーザー用にインストールすることもでき、これらは保存されます。
ワークスペースディレクトリ - デフォルトでは、
/workspace/pandas-devです。これがGitpodで保持される唯一のディレクトリであるため、**これを変更しないでください**。
開発エクスペリエンスを支援するために、いくつかのツールとVSCode拡張機能もプリインストールしました。
Gitpodを使用した開発ワークフロー#
ドキュメントのpandasへの貢献セクションには、pandasの開発ワークフローに関する情報が含まれています。貢献に取り組む前に、必ずこれを確認してください。
Gitpodを使用する場合、gitは事前に構成されています。
GitHub経由で認証したため、gitのユーザー名とメールアドレスを設定する必要はありません。これは自動的に行われます。ただし、メールアドレスを非公開にするためにGitHub機能を使用している場合は異なります。ターミナルでコマンド
git config --listを使用して、git構成を確認できます。git config --global user.email “your-secret-email@users.noreply.github.com”を使用して、GitHubプロファイルでコミットに使用するメールアドレスに設定してください。自分のpandasフォークからワークスペースを開始したため、デフォルトでは、リモートとして
upstreamとoriginの両方が追加されます。これは、ターミナルでgit remoteと入力するか、ステータスバーの**ブランチ名**をクリックして確認できます（下の画像を参照）。
pandasドキュメントのレンダリング#
Sphinxを使用したドキュメントのレンダリング方法の詳細については、pandasドキュメントの作成方法セクションをご覧ください。ドキュメント全体を作成するには、/docディレクトリで次のコマンドを実行する必要があります。
$ cd doc
$ python make.py html
または、次のコマンドで単一のページを作成できます。
python make.py --single development/contributing_gitpod.rst
Gitpodでドキュメントをレンダリングするには、主に2つのオプションがあります。
オプション1：Liveserveの使用#
pandas/doc/build/htmlでドキュメントを表示します。ページのレンダリングされたバージョンを表示するには、
.htmlファイルを右クリックし、**Live Serveで開く**をクリックします。または、エディターでファイルを開き、ステータスバーの**Go live**ボタンをクリックすることもできます。
エディターの右側にシンプルなブラウザーが開きます。これを閉じて、ポップアップの**ブラウザーで開く**ボタンをクリックすることをお勧めします。
サーバーを停止するには、ステータスバーの**ポート：5500**ボタンをクリックします。
オプション2：rst拡張機能の使用#
.rstファイルで作業中に、リアルタイムで変更を確認する簡単で迅速な方法は、docutilsでrst拡張機能を使用することです。
注意
これにより、htmlテーマを使用せずに、ドキュメントのシンプルなライブプレビューが生成され、一部のバックリンクが正しく追加されない場合があります。ただし、これは、htmlファイルを作成せずに、作業に関する即座のフィードバックを得るための簡単で軽量な方法です。
エディターで、
doc/sourceにあるソースドキュメントファイルを開きます。MacではCmd-Shift-Pを、LinuxとWindowsではCtrl-Shift-Pを使用してVSCodeコマンドパレットを開きます。「restructured」と入力し始め、「プレビューを開く」または「横にプレビューを開く」を選択します。
ドキュメントを操作すると、エディターにライブレンダリングが表示されます。
htmlテーマを使用した最終出力を見たい場合は、make htmlでドキュメントを再構築し、オプション1で説明したようにLive Serveを使用する必要があります。
よくある質問とトラブルシューティング#
Gitpodワークスペースはどのくらいの期間保持されますか？#
停止したワークスペースは14日間保持され、使用しない場合はその後削除されます。
以前のワークスペースに戻ることはできますか？#
はい、しばらく離れていて、pandasの貢献作業を再開したいとします。https://gitpod.io/workspacesにアクセスし、再度起動したいワークスペースをクリックする必要があります。すべての変更は最後に終了したときと同じ場所にあります。
追加のVSCode拡張機能をインストールできますか？#
もちろんです！インストールした拡張機能は、自分のワークスペースにインストールされ、保存されます。
Gitpodに登録しましたが、リポジトリにGitpodボタンが表示されません。#
https://gitpod.io/integrations にアクセスし、ログインしていることを確認してください。GitHubにカーソルを合わせ、右側に表示される3つのボタンをクリックします。「権限の編集」をクリックし、user:email、read:user、public_repo にチェックが入っていることを確認します。「権限の更新」をクリックし、GitHubアプリケーションページで変更を承認します。
ワークスペースを使用していない場合、どれくらいの間アクティブなままですか？#
ブラウザのタブでワークスペースを開いたままにしていても、操作しない場合は30分後にシャットダウンします。ブラウザのタブを閉じると、3分後にシャットダウンします。
ターミナルが空白です - カーソルがなく、完全に反応しません#
残念ながら、これはGitpod側の既知の問題です。この問題は2つの方法で解決できます。
新しいGitpodワークスペースを完全に作成します。
Gitpodダッシュボード にアクセスし、実行中のワークスペースを見つけます。カーソルを合わせ、3つのドットメニュー をクリックし、次に 停止 をクリックします。ワークスペースが完全に停止したら、その名前をクリックして再起動できます。
GitHub経由で認証しましたが、Gitpod経由でリポジトリにコミットできません。#
https://gitpod.io/integrations にアクセスし、ログインしていることを確認してください。GitHubにカーソルを合わせ、右側に表示される3つのボタンをクリックします。「権限の編集」をクリックし、public_repo にチェックが入っていることを確認します。「権限の更新」をクリックし、GitHubアプリケーションページで変更を承認します。
謝辞#
このページは、NumPy プロジェクトを基に若干の修正を加えています。