Skip to main content

Interface to the NetFoundry network-as-code orchestration Platform

Project description

User Guide

Python module guide

Find the Version

$ python3 -m netfoundry.version
v5.2.0

Play the demo

This creates a demo network named "BibbidiBobbidiBoo" with your API account stored in ~/.netfoundry/credentials.json

Learn about getting an API account by reading the Authentication Guide

python3 -m netfoundry.demo --network=BibbidiBobbidiBoo

Create network snippet from demo.py

#!/usr/bin/env python3
import netfoundry

# user-default path is ~/.netfoundry/
organization = netfoundry.Organization(credentials="credentials.json")

# use some Network Group, default is to use the first and there's typically only one
network_group = netfoundry.NetworkGroup(organization)

# create a Network
network_name = "BibbidiBobbidiBoo"
if network_name in network_group.networks_by_name().keys():
    # use the Network
    network = netfoundry.Network(network_group, network_name=network_name)
    network.wait_for_status("PROVISIONED",wait=999,progress=True)
else:
    network_id = network_group.create_network(name=network_name)['id']
    network = netfoundry.Network(network_group, network_id=network_id)
    network.wait_for_status("PROVISIONED",wait=999,progress=True)

Publish a new version of the module

Video Tour of Release Procedure

00:00 Welcome Pythonistas
00:50 Determine next version number
01:30 GitFlow Release Start
02:10 Project Conventional Release Branch Name in Actions Workflow
02:30 Make a Change to Patch the Module
04:00 Git Commit the Change
04:30 GitFlow Publish Release to Git Remote
05:00 Create Pull Request
05:30 GitHub Actions Checks Triggered by Pull Request
06:00 Local testing with "editable" module and TestPyPi
09:00 Complete Pull Request
09:30 GitFlow Release Finish and Push Git Tags
10:30 GitHub Create Release
12:00 Verify Published Artifacts in PyPi and Hub
12:30 PyPi Upgrade Gets New Version
13:30 Docker Run Check Version

Project details


Release history Release notifications | RSS feed

This version

5.8.6

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netfoundry-5.8.6.tar.gz (73.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netfoundry-5.8.6-py3-none-any.whl (61.2 kB view details)

Uploaded Python 3

File details

Details for the file netfoundry-5.8.6.tar.gz.

File metadata

  • Download URL: netfoundry-5.8.6.tar.gz
  • Upload date:
  • Size: 73.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for netfoundry-5.8.6.tar.gz
Algorithm Hash digest
SHA256 fe71e038dcd6fb672afbea3f3f8704c93bae2ca56a369bf5941803f4e020a550
MD5 fcd6ba52cc222e16e780dc1150219b22
BLAKE2b-256 a8112ae9d4b27b64c97995f00dd7817ddd73edd376e3a4db98ce135da42a8ea5

See more details on using hashes here.

File details

Details for the file netfoundry-5.8.6-py3-none-any.whl.

File metadata

  • Download URL: netfoundry-5.8.6-py3-none-any.whl
  • Upload date:
  • Size: 61.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for netfoundry-5.8.6-py3-none-any.whl
Algorithm Hash digest
SHA256 8a1080192dde3bfc710ab14556679e6998d5912174187e0a548696f29120cdcb
MD5 7e674ff192c07b8402c3eac72dae7a58
BLAKE2b-256 6525e794c132b19ff73fd631a3df1c4dee1328a5db0286accc3ad2168a3afbd3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page