pythonパッケージの使い方の調べ方

Question

PyPIにあるパッケージを使ってみようと思って、pipでインストールしてみました。
PyPIのサイトでパッケージを検索すると、DescriptionやUsageの項目があるので、英文ですが、だいたい使い方はわかります。
もし、使いたいパッケージがあった場合というのは、そのパッケージに含まれる関数や機能などはどうやって調べるものなのでしょうか。

windowsのコマンドラインだと、例えばdir /?なので、コマンドを調べれたりしますが、コマンドで調べることはできないものでしょうか。
（サイトやreadme(?)などを確認するのが一般的でしょうか？）

よろしくお願いします

Answer 1

基本的に、パッケージが提供しているマニュアルを見るのが一番です。

pythonの場合、pydoc(python3の場合はpydoc3)というコマンドがあり、引数にモジュール名(「import module」でインポートする際の「module」)を指定する事により、ソースコードに書かれたdocstringを元にドキュメントを出力します。

pydoc3 os

• pydoc --- ドキュメント生成とオンラインヘルプシステム

まぁ、私自身はあまりpydocは使いませんけどね(^^;

Comments

[roku28632]

なるほどー。pydocというものもあるんですね。
やっぱりマニュアルやリファレンスを参照するのが一般的ですね。
ありがとうございます。

Answer 2

コマンドに-hまたは--help等を入れるとコマンドの使い方が出てきます。
それかそのライブラリのウェブサイトで使い方を調べましょう

Comments

[LouiS0616]

知りたいのはpipコマンドの使い方では無く、pip経由で導入したパッケージの使い方だと思うのです。

[roku28632]

すいません。
質問の内容がわかりづらかったです。
知りたいのはコメントに書いていただいている、「pip経由で導入したパッケージの使い方」です。
たしかに、pipであれば、pip --helpで使い方を調べれました。
たとえば、pip install coloramaした、coloramaの使い方についてを知りたい場合です。

[Nippun]

https://github.com/tartley/colorama
ドキュメントを読むのではダメですかね？
すみませんが知る限りコマンド経由での方法はわからないです

[roku28632]

ドキュメントを読む。というのでも全然いいです。
知りたいのは、通常どうやって調べるものなのか、という点です。
自分でゴニョゴニョ触っていると、慣例のようなものを学べないので、みなさんどうやっているのかなと思ったのです。

[Nippun]

基本は公式ドキュメントを読んで調べる物ですね。
公式ドキュメントだとわかりにくいものはググってみるといった感じでしょうか