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

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.9.tar.gz (113.9 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.9-py2.py3-none-any.whl (102.5 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: netfoundry-5.8.9.tar.gz
  • Upload date:
  • Size: 113.9 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.9.tar.gz
Algorithm Hash digest
SHA256 099c7e0288714ea61ba758e1a07887c10a70d9695ceec6c3f2ac07d8b7c58528
MD5 8caaf4a47f5a4f392dec9208513ba2ee
BLAKE2b-256 54d6279632ba9023a31e7483626c4235f5cacf0da1708d9b55b0bc83c1a2780b

See more details on using hashes here.

File details

Details for the file netfoundry-5.8.9-py2.py3-none-any.whl.

File metadata

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

File hashes

Hashes for netfoundry-5.8.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3d5e9212dbc1a86cbe5972945bc89bf555bf10401776031317bedbc8fe6f0053
MD5 5960d8a597bd4c2cc88b6052f7a5a4ac
BLAKE2b-256 3640cdfba85bd0dbdc4ffd4f7b5bc36b4b48a9c64091e2cd22ee1b09697b272b

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