ドキュメントは、ユーザーが関数の使い方を学ぶ助けになるだけでなく、将来の自分への備忘録にもなります。
この演習では、NumPy 形式のドキュメント用テンプレートに記入して、読みやすく美しいドキュメントを作成します。
NumPy スタイルでのドキュメント記述については、前の動画と このドキュメント を参照してください。
この演習はコースの一部です
理論を実践に変える、インタラクティブな演習のひとつをお試しください
これまでに書いたスクリプトを変換して、パッケージづくりを始めましょう。自分のコンピュータ上で使えるシンプルなパッケージを作成します。
現在の演習
自分も他の人もインストールできるパッケージにしましょう。この章では、依存関係の扱い方、READMEの書き方、ライセンスの含め方を学びます。さらに、Pythonパッケージの主要な公開先であるPyPIにパッケージを公開するまでの全手順を完了します。
パッケージをプロ水準に仕上げましょう。エラーを防ぐpytestの使い方、複数のPythonバージョンで動作を確認するtox、そして優れたコードスタイルを保つflake8の活用法を学びます。
より速くパッケージを作成しましょう。最終章では、cookiecutterを使って必要な補助ファイル一式を自動生成する方法、Makefileで新バージョンのリリースを簡素化する方法、そしてユーザーやコントリビューターを惹きつけるために必要な残りのファイルについて紹介します。