NetFoundry Python Module
This module has a general-purpose library for using the NetFoundry API and installs the CLI nfctl.
User Guide
Find the Version
$ python3 -m netfoundry.version
v5.2.0
# or
$ nfctl version
v5.2.0
Play the demo
This creates a demo network with your API account file named credentials.json stored in the current directory or the XDG config directory e.g. ~/.config/netfoundry/. Learn how to obtain and use an API account for your NetFoundry organization in the Authentication Guide
nfctl demo
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_group.network_exists(network_name):
# use the network
network = netfoundry.Network(network_group, network_name=network_name)
network.wait_for_status("PROVISIONED")
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")
Publish a new version of the module
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
5 maintainers
Metadata
5 maintainers
Release files for netfoundry 5.11.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| netfoundry-5.11.3.tar.gz | 121.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| netfoundry-5.11.3-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 226.9 kB
Release files / netfoundry-5.11.3.tar.gz
| Download URL | netfoundry-5.11.3.tar.gz |
|---|---|
| Size | 121.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
22323334347de95ba57b4f1339d471f3bf65bcd9312b866960ad3f304c2600a7
|
|
BLAKE2b-256 checksum How to use checksums |
b2816d780d5a32870e2791a0554fe0ddd04aba4172cc5ac2adb5391b52f06082
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / netfoundry-5.11.3-py2.py3-none-any.whl
| Download URL | netfoundry-5.11.3-py2.py3-none-any.whl |
|---|---|
| Size | 105.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
ae2259645c0ce2f677f4bceff342c2914f8c55a7e9f6e229495c2d116249f84b
|
|
BLAKE2b-256 checksum How to use checksums |
74a8488de1e900fca979b4a3efbfac862c5a4c8de62bb1ca814ed32b43e31207
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Security for netfoundry 5.11.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
