Welcome to Fabric’s documentation!

This site covers Fabric’s usage & API documentation. For basic info on what Fabric is, including its public changelog & how the project is maintained, please see the main project website.

チュートリアル

新しいユーザーやFabricの基本的な機能の概要を知りたい方は チュートリアル を参照してください。このドキュメントの残りの部分では、内容に関して少なくとも一時的にはよく知っていることと仮定します。

APIドキュメント

Fabricは2つのAPIドキュメントをメンテナンスしています。これはソースコードのdocstringsから自動生成されるもので、通常はとても詳細なものです。

コアAPI

コア APIは、Fabricの基礎的な構成要素(runsudo など)を形成する関数、クラス、メソッドとしておおまかに定義されています。そしてこの上に他のすべて(以下の “contrib” セクションやユーザーのfabfile)が作られています。

Contrib API

Fabricの contrib パッケージにはユーザーI/O、リモートファイルの修正などのタスクようにに一般的で便利なツールが含まれています(たいていはユーザーのfabfileからマージされています)。coreのAPIが小さくサイズに保たれ比較的長期間にわたって変更されないのに対し、このcontribセクションはユーザーケースが解決されて追加されるごとに成長し、(後方互換性は保つようにしてはいますが)進化します。