netfoundry


Namenetfoundry JSON
Version 4.10.0 PyPI version JSON
download
home_pagehttps://developer.netfoundry.io/guides/python/
SummaryInterface to the NetFoundry network-as-code orchestration Platform
upload_time2021-06-16 14:02:42
maintainer
docs_urlNone
authorKenneth Bingham
requires_python>=3.6
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
## User Guide

[Python module guide](https://developer.netfoundry.io/guides/python/)

## 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](https://developer.netfoundry.io/v2/guides/authentication/)

```bash
$ python3 -m netfoundry.demo BibbidiBobbidiBoo
INFO: running demo script in /home/alice/.pyenv/versions/3.9.0/lib/python3.9/site-packages/netfoundry/demo.py
```

## Create network snippet from demo.py

```python
#!/usr/bin/env python3
import netfoundry

# default API account credential file is ~/.netfoundry/credentials.json
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)
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://developer.netfoundry.io/guides/python/",
    "name": "netfoundry",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "",
    "author": "Kenneth Bingham",
    "author_email": "support@netfoundry.io",
    "download_url": "https://files.pythonhosted.org/packages/a5/57/3519ee89923c18d335a9d5749268f45c8094ae3d580d3b00575fea96f12c/netfoundry-4.10.0.tar.gz",
    "platform": "",
    "description": "\n## User Guide\n\n[Python module guide](https://developer.netfoundry.io/guides/python/)\n\n## Play the demo\n\nThis creates a demo network named \"BibbidiBobbidiBoo\" with your API account stored in ~/.netfoundry/credentials.json\n\nLearn about getting an API account by reading the [Authentication Guide](https://developer.netfoundry.io/v2/guides/authentication/)\n\n```bash\n$ python3 -m netfoundry.demo BibbidiBobbidiBoo\nINFO: running demo script in /home/alice/.pyenv/versions/3.9.0/lib/python3.9/site-packages/netfoundry/demo.py\n```\n\n## Create network snippet from demo.py\n\n```python\n#!/usr/bin/env python3\nimport netfoundry\n\n# default API account credential file is ~/.netfoundry/credentials.json\nOrganization = netfoundry.Organization(credentials=\"credentials.json\")\n\n# use some Network Group, default is to use the first and there's typically only one\nnetwork_group = netfoundry.NetworkGroup(Organization)\n\n# create a Network\nnetwork_name = \"BibbidiBobbidiBoo\"\nif network_name in network_group.networks_by_name.keys():\n    # use the Network\n    network = netfoundry.Network(network_group, network_name=network_name)\n    network.wait_for_status(\"PROVISIONED\",wait=999,progress=True)\nelse:\n    network_id = network_group.create_network(name=network_name)['id']\n    network = netfoundry.Network(network_group, network_id=network_id)\n    network.wait_for_status(\"PROVISIONED\",wait=999,progress=True)\n```\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Interface to the NetFoundry network-as-code orchestration Platform",
    "version": "4.10.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5419b36db028587a9df9cfae59a1d92e",
                "sha256": "336b760e4f630c26c64ea2fd07976a181252c0c8658bd772c0ac3088691d17de"
            },
            "downloads": -1,
            "filename": "netfoundry-4.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5419b36db028587a9df9cfae59a1d92e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 33834,
            "upload_time": "2021-06-16T14:02:40",
            "upload_time_iso_8601": "2021-06-16T14:02:40.838705Z",
            "url": "https://files.pythonhosted.org/packages/e3/a9/9d0d584d5e44dc333f5f17cb5112f34dadeeb75df2cb63fe160d5b41d6c7/netfoundry-4.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "ec2404bea173477419adeade48eb534b",
                "sha256": "9740118e863d6a43eacda965531ca69e188ddfd4ae5e2e52d6960fb1117beda7"
            },
            "downloads": -1,
            "filename": "netfoundry-4.10.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ec2404bea173477419adeade48eb534b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 29839,
            "upload_time": "2021-06-16T14:02:42",
            "upload_time_iso_8601": "2021-06-16T14:02:42.373796Z",
            "url": "https://files.pythonhosted.org/packages/a5/57/3519ee89923c18d335a9d5749268f45c8094ae3d580d3b00575fea96f12c/netfoundry-4.10.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-06-16 14:02:42",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "netfoundry"
}
        
Elapsed time: 0.26064s