Got questions, feedback, or feature requests? Join our community on Slack!
pybatfish is a Python client for Batfish.
It allows you to easily get started exploring and validating your network.
Run interactively within a python shell or fully automate your network validation pipeline.
Warning: Pybatfish public API is being updated, note that API names and parameters will soon change.
-
Access to a running Batfish service (which could be running locally). See here for building and running Batfish service.
-
Python runtime is required. We strongly encourage you to use Python 3. While Python 2.7 is still supported, it is nearing end of life, and so is our support for it.
-
For interactive use, we strongly encourage you to use IPython or a Jupyter notebook
Run the following from the top-level directory of the repository:
pip install .
To install in development mode, append the -e flag:
pip install -e .
See our full documentation and the getting started guide