Skip to content

Commit

Permalink
2.4.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
rschmied committed Jun 9, 2022
1 parent c59feb4 commit 93e7151
Show file tree
Hide file tree
Showing 48 changed files with 2,015 additions and 7,270 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.6, 3.7, 3.8, 3.9]
python-version: [3.7, 3.8, 3.9]

steps:
- uses: actions/checkout@v2
Expand All @@ -42,4 +42,3 @@ jobs:
- name: Test with pytest
run: |
pytest
13 changes: 2 additions & 11 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,25 +1,16 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks

#
# for the eslint command to work, this is needed:
#
# yarn global add eslint
#
# however, this might still not be the correct solution
# as the eslintrc.json and some eslint plugins are
# probably only available when in the proper directory
#

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v2.4.0
rev: v4.1.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-added-large-files
- repo: https://github.com/psf/black
rev: 21.5b1
rev: 22.1.0
hooks:
- id: black
language_version: python3
2 changes: 1 addition & 1 deletion NOTICE
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Python bindings for the Cisco VIRL 2 Network Simulation Platform

Copyright (c) 2020 Cisco Systems, Inc. and/or its affiliates
Copyright (c) 2019-2022, Cisco Systems, Inc. and/or its affiliates

This project includes software developed at Cisco Systems, Inc. and/or its affiliates.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This is the client library for the Cisco VIRL 2 Network Simulation Platform
edit, delete and control network simulations on a VIRL 2 controller.

It is a pure Python implementation that requires Python3. We've tested and
written the package with Python 3.6.8.
written the package with Python 3.8.10.

The **status** of this package can be considered **Beta**. We're not aware of
any major issues at the time of release. However, since this is the first
Expand Down Expand Up @@ -46,6 +46,11 @@ proper version/build information. For example

We recommend the use of a virtual environment for installation.

If you want to interact with devices via the client library, you need to
install pyATS library.

pip3 install pyats

## Usage

The package itself is fairly well documented using docstrings. In addition, the
Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#
# This file is part of VIRL 2
# Copyright (c) 2019, Cisco Systems, Inc.
# Copyright (c) 2019-2022, Cisco Systems, Inc.
# All rights reserved.
#
# -*- coding: utf-8 -*-
Expand All @@ -26,7 +26,7 @@
# -- Project information -----------------------------------------------------

project = "virl2_client"
copyright = "2020, Cisco Systems, Inc"
copyright = "Copyright (c) 2019-2022, Cisco Systems, Inc."
author = "VIRL2 team <virl@cisco.com>"

# The short X.Y version
Expand Down
4 changes: 2 additions & 2 deletions docs/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -278,12 +278,12 @@ The output for this would look something like the following::
]
"reservation_mode": false,
"transport": {
"ssms": "https://tools.cisco.com/its/service/oddce/services/DDCEService",
"ssms": "https://smartreceiver.cisco.com/licservice/license",
"proxy": {
"server": null,
"port": null
},
"default_ssms": "https://tools.cisco.com/its/service/oddce/services/DDCEService"
"default_ssms": "https://smartreceiver.cisco.com/licservice/license"
},
"udi": {
"hostname": "cml2-controller",
Expand Down
1 change: 0 additions & 1 deletion docs/template/module.rst_t
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@
{%- for option in automodule_options %}
:{{ option }}:
{%- endfor %}

1 change: 0 additions & 1 deletion docs/template/toc.rst_t
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,3 @@
{% for docname in docnames %}
{{ docname }}
{%- endfor %}

10 changes: 5 additions & 5 deletions examples/licensing.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#!/usr/bin/env python3
#
# Python bindings for the Cisco VIRL 2 Network Simulation Platform
#
# This file is part of VIRL 2
# Copyright (c) 2019-2022, Cisco Systems, Inc.
# All rights reserved.
#
# Copyright 2020 Cisco Systems Inc.
# Python bindings for the Cisco VIRL 2 Network Simulation Platform
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -97,12 +97,12 @@
},
"reservation_mode": false,
"transport": {
"ssms": "https://tools.cisco.com/its/service/oddce/services/DDCEService",
"ssms": "https://smartreceiver.cisco.com/licservice/license",
"proxy": {
"server": null,
"port": null
},
"default_ssms": "https://tools.cisco.com/its/service/oddce/services/DDCEService"
"default_ssms": "https://smartreceiver.cisco.com/licservice/license"
},
"features": [
{
Expand Down
6 changes: 3 additions & 3 deletions examples/link_conditioning.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#!/usr/bin/env python3
#
# Python bindings for the Cisco VIRL 2 Network Simulation Platform
#
# This file is part of VIRL 2
# Copyright (c) 2019-2022, Cisco Systems, Inc.
# All rights reserved.
#
# Copyright 2020 Cisco Systems Inc.
# Python bindings for the Cisco VIRL 2 Network Simulation Platform
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down
8 changes: 4 additions & 4 deletions examples/sample.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#!/usr/bin/env python3
#
# Python bindings for the Cisco VIRL 2 Network Simulation Platform
#
# This file is part of VIRL 2
# Copyright (c) 2019-2022, Cisco Systems, Inc.
# All rights reserved.
#
# Copyright 2020 Cisco Systems Inc.
# Python bindings for the Cisco VIRL 2 Network Simulation Platform
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -94,5 +94,5 @@
status = cl.licensing.deregister()
cl.licensing.remove_certificate()
# set licensing back to default transport
# default ssms is "https://tools.cisco.com/its/service/oddce/services/DDCEService"
# default ssms is "https://smartreceiver.cisco.com/licservice/license"
cl.licensing.set_default_transport()
Loading

0 comments on commit 93e7151

Please sign in to comment.