Contributing

🎉 Thank you for taking the time to contribute to pyinfra! 🎉

Third party pull requests help expand pyinfra’s functionality and are essential to it’s continued growth. This guide should help get you started adding additional operations/facts to pyinfra.

Guides

• How to write operations
• How to write facts
• How to write connectors
• API reference

Dev Setup

# Create a virtualenv
virtualenv /path/to/venv

# Clone the repo
git clone git@github.com:Fizzadar/pyinfra.git

# Install the package in editable mode with development requirements
pip install -e .[dev]

Tests

Use pytest to run tests, or pytest --cov to run with coverage. Pull requests are expected to be tested and not drop overall project coverage by >1%.

Generate Documentation

To generate:

scripts/build_docs.sh

To view (localhost:8000):

cd docs/build/
python -m http.server

Code Style

• 100 max line length
• no hanging indents
• single quotes everywhere possible