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.
For new users, and/or for an overview of Fabric’s basic functionality, please see the Overview and Tutorial. The rest of the documentation will assume you’re at least passingly familiar with the material contained within.
The following list contains all major sections of Fabric’s prose (non-API) documentation, which expands upon the concepts outlined in the Overview and Tutorial and also covers advanced topics.
- The environment dictionary,
- Execution model
faboptions and arguments
- Fabfile construction and use
- Interaction with remote programs
- Library Use
- Managing output
- Parallel execution
- SSH behavior
- Defining tasks
Fabric maintains two sets of API documentation, autogenerated from the source code’s docstrings (which are typically very thorough.)
The core API is loosely defined as those functions, classes and methods
which form the basic building blocks of Fabric (such as
sudo) upon which everything
else (the below “contrib” section, and user fabfiles) builds.
Fabric’s contrib package contains commonly useful tools (often merged in from user fabfiles) for tasks such as user I/O, modifying remote files, and so forth. While the core API is likely to remain small and relatively unchanged over time, this contrib section will grow and evolve (while trying to remain backwards-compatible) as more use-cases are solved and added.
Contributing & Running Tests¶
For advanced users & developers looking to help fix bugs or add new features.