Got questions, feedback, or feature requests? Join our community on Slack!
pybatfish is a Python client for Batfish.
It allows you to interactively explore or validate your network and embed validation in your automation pipeline.
There are two options for running pybatfish.
This container bundles Batfish and pybatfish. Use this option if you want to just play with example networks and Jupyter notebooks.
Instructions for running this container are here.
Use this option when you want to analyze your own networks and have access to a running Batfish service (via the Batfish docker container or directly from sources).
To install pybatfish, run pip install . from the top-level directory of the repository. (We recommend Python 3 as the Python runtime. While Python 2.7 is supported, it is nearing end of life.)
Once pybatfish is installed, you can run the example Jupyter notebooks:
pip install jupyter
cd jupyter_notebooks
jupyter notebooks
You can begin analyzing your own networks by modifying the examples and pointing them at your data.
Complete documentation of pybatfish APIs is here.