Python Guide

The Python module netfoundry is a general-purpose library and thin wrapper for the NetFoundry platform API.


Free-tier subscribers can always ask for help with the Python module in Community or GitHub. Learn more about contacting support.


Installing the Python3 module is easy with pip.

Python Package Index module
Python3 interface to the NetFoundry API
pip install netfoundry


A container image with the latest Python module already installed: netfoundry/python:latest

nfctl demo

The NetFoundry CLI nfctl is an example of an application using the netfoundry Python module. The CLI has a built-in demo you can run and read here.

# or find the installed source file for under FILE heading of the built-in doc
nfctl demo

There’s a separate article here dedicated to this demo.