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.5.0

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.5.0.tar.gz (64.8 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.5.0-py3-none-any.whl (53.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: netfoundry-5.5.0.tar.gz
  • Upload date:
  • Size: 64.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for netfoundry-5.5.0.tar.gz
Algorithm Hash digest
SHA256 a147b62d3e010fd01435e0e8a8d2b4bde841a372411c951fe3de351c1710c211
MD5 88ccf6931d516152af537af773b0eb30
BLAKE2b-256 29f9f6a6ba517a3e9f650f80dd4b93076ef0fc29b35fd83100df8184275f27e4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: netfoundry-5.5.0-py3-none-any.whl
  • Upload date:
  • Size: 53.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

File hashes

Hashes for netfoundry-5.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 473c3b44472bbc4fe8d9c17ac4353404c3e51085afb12ece0ebb7a6be9c5a36d
MD5 e564939e8da431141b4764ae76403802
BLAKE2b-256 70b7c4c9b522952f5102205520089c46917072df1c4f2afdd0471299c4cac753

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