From a72f5ce7794096fe84399bf807b5f2fa99129885 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:03:11 +0100 Subject: [PATCH 01/27] Doc requirements --- .readthedocs.yaml | 6 +++--- docs/{doc-requirements.txt => requirements.txt} | 11 +++++++---- 2 files changed, 10 insertions(+), 7 deletions(-) rename docs/{doc-requirements.txt => requirements.txt} (79%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index dd2aa46..31dbf0d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -30,6 +30,6 @@ sphinx: # Optional but recommended, declare the Python requirements required # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/doc-requirements.txt b/docs/requirements.txt similarity index 79% rename from docs/doc-requirements.txt rename to docs/requirements.txt index 4fc269c..cec6525 100644 --- a/docs/doc-requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,10 @@ -Cython==0.29.10 -recommonmark==0.5.0 -Sphinx==2.1.1 -sphinx-rtd-theme==0.4.3 +Cython +Sphinx +# Cython==0.29.10 +# recommonmark==0.5.0 +# Sphinx==2.1.1 +# sphinx-rtd-theme==0.4.3 +-e git+https://github.com/riverbed/steelscript.git#egg=steelscript -e git+https://github.com/riverbed/steelscript-appresponse.git#egg=steelscript.appresponse -e git+https://github.com/riverbed/steelscript-netprofiler.git#egg=steelscript.netprofiler -e git+https://github.com/riverbed/steelscript-wireshark.git#egg=steelscript.wireshark From 3e30401072106d16f66abf8327f57b20c5826034 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:10:03 +0100 Subject: [PATCH 02/27] sphinx-rtd-theme --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index cec6525..61a0372 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,6 @@ Cython Sphinx +sphinx-rtd-theme # Cython==0.29.10 # recommonmark==0.5.0 # Sphinx==2.1.1 From b85ecb7627bd094a4456e04da02ff35af6cef480 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:14:10 +0100 Subject: [PATCH 03/27] Use add_stylesheet ( add_stylesheet is deprecated) --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 7a1e840..1c4ec00 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -288,6 +288,6 @@ def setup(app): # add custom css that overrides the default theme - app.add_stylesheet('theme.css') + app.add_css_file('theme.css') # Register the docstring processor with sphinx #app.connect('autodoc-process-docstring', process_docstring) From e66ade7d815c3f44de09f201c832a4e4fa75acdd Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:26:19 +0100 Subject: [PATCH 04/27] Doc: Temporarily disable cython_highlighting extension (patch TypeError: 'CythonLexer' object is not callable) --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 1c4ec00..084168e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinx.ext.autodoc', - 'cython_highlighting', +# 'cython_highlighting', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage'] From 0be3b25e80aa349c27e8f036a06884474a6ecdf2 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:31:46 +0100 Subject: [PATCH 05/27] Update requirements.txt --- docs/requirements.txt | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 61a0372..4b99a0c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,10 +1,6 @@ Cython Sphinx sphinx-rtd-theme -# Cython==0.29.10 -# recommonmark==0.5.0 -# Sphinx==2.1.1 -# sphinx-rtd-theme==0.4.3 -e git+https://github.com/riverbed/steelscript.git#egg=steelscript -e git+https://github.com/riverbed/steelscript-appresponse.git#egg=steelscript.appresponse -e git+https://github.com/riverbed/steelscript-netprofiler.git#egg=steelscript.netprofiler From e01797703f8f98b5999770ca170aa814d1b2d492 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:34:02 +0100 Subject: [PATCH 06/27] Testing with packets --- docs/conf.py | 2 +- docs/requirements.txt | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 084168e..1c4ec00 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinx.ext.autodoc', -# 'cython_highlighting', + 'cython_highlighting', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage'] diff --git a/docs/requirements.txt b/docs/requirements.txt index 4b99a0c..f32008d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,9 +4,10 @@ sphinx-rtd-theme -e git+https://github.com/riverbed/steelscript.git#egg=steelscript -e git+https://github.com/riverbed/steelscript-appresponse.git#egg=steelscript.appresponse -e git+https://github.com/riverbed/steelscript-netprofiler.git#egg=steelscript.netprofiler --e git+https://github.com/riverbed/steelscript-wireshark.git#egg=steelscript.wireshark -e git+https://github.com/riverbed/steelscript-cmdline.git#egg=steelscript.cmdline -e git+https://github.com/riverbed/steelscript-scc.git#egg=steelscript.scc -e git+https://github.com/riverbed/steelscript-steelhead.git#egg=steelscript.steelhead +-e git+https://github.com/riverbed/steelscript-wireshark.git#egg=steelscript.wireshark +-e git+https://github.com/riverbed/steelscript-packets.git#egg=steelscript.packets -e git+https://github.com/riverbed/reschema.git#egg=reschema -e git+https://github.com/riverbed/sleepwalker.git#egg=sleepwalker From 09086526587a679d2f3cd3a843715a1beffe621f Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:35:24 +0100 Subject: [PATCH 07/27] Remove $ --- docs/index.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index fabd8c7..63b710d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,8 +25,8 @@ Installing If you already have pip, just run the following (in a `virtualenv `_):: - $ pip install steelscript - $ steel install + pip install steelscript + steel install Not sure about pip, but you know you have Python? @@ -34,7 +34,7 @@ Not sure about pip, but you know you have Python? 2. Run it (in a `virtualenv `_):: - $ python steel_bootstrap.py install + python steel_bootstrap.py install Adding a module with steel command ---------------------------------- @@ -47,7 +47,7 @@ provided in this package. Once you have the base ``steelscript`` package installed, getting started is just one command away:: - $ steel install --steelhead + steel install --steelhead For more details, see the :doc:`complete documentation `. From 914197b2f8fdfc2f078e073cbff958affbb03dc1 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:36:37 +0100 Subject: [PATCH 08/27] Disable cython_highlighting extension --- docs/conf.py | 2 +- docs/requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1c4ec00..084168e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,7 +42,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinx.ext.autodoc', - 'cython_highlighting', +# 'cython_highlighting', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage'] diff --git a/docs/requirements.txt b/docs/requirements.txt index f32008d..1c3b5d7 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -8,6 +8,6 @@ sphinx-rtd-theme -e git+https://github.com/riverbed/steelscript-scc.git#egg=steelscript.scc -e git+https://github.com/riverbed/steelscript-steelhead.git#egg=steelscript.steelhead -e git+https://github.com/riverbed/steelscript-wireshark.git#egg=steelscript.wireshark --e git+https://github.com/riverbed/steelscript-packets.git#egg=steelscript.packets +# -e git+https://github.com/riverbed/steelscript-packets.git#egg=steelscript.packets -e git+https://github.com/riverbed/reschema.git#egg=reschema -e git+https://github.com/riverbed/sleepwalker.git#egg=sleepwalker From f58f8f17d405d3dd23235b4b9bb3435810c97d5b Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:41:32 +0100 Subject: [PATCH 09/27] Header --- docs/index.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 63b710d..cdd7f17 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,9 +2,11 @@ Riverbed SteelScript for Python =============================== +.. note:: + For quick starts and more about the latest version of `SteelScript `_ for Python 3, please refer to `SteelScript repository in GitHub `_ + .. warning:: - For quick starts and more about the latest version of `SteelScript `_ for Python 3, please refer to `SteelScript repository in GitHub `_ - This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. + This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. Welcome, this is the documentation of `Riverbed SteelScript `_ From 4f11656d29a83126a94c82bbd2935aef07cf2555 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:53:27 +0100 Subject: [PATCH 10/27] Header --- docs/index.rst | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index cdd7f17..07c4775 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,23 +2,17 @@ Riverbed SteelScript for Python =============================== -.. note:: - For quick starts and more about the latest version of `SteelScript `_ for Python 3, please refer to `SteelScript repository in GitHub `_ - -.. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. +`SteelScript `_ is a collection of Python modules that build upon REST APIs and other interfaces to interact with Riverbed appliances and software. - -Welcome, this is the documentation of `Riverbed SteelScript `_ -The core `SteelScript `_ is a collection of Python modules that build upon REST APIs and other interfaces to interact with Riverbed appliances and software. - -Getting started with SteelScript (latest) -========================================= +.. note:: -Please go to `SteelScript repository in GitHub `_ for quick starts and more about the latest version of `SteelScript `_ for **Python 3** + Please go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + that works in container, supports Python 3 and more. +.. warning:: + This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. -*outdated* Getting started with SteelScript 2.0 for Python 2 +<<*outdated*>> Getting started with SteelScript 2.0 for Python 2 ========================================================== Installing From 4b5453e32a15518378b7a8d33c2b60a952bb6a9b Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:56:28 +0100 Subject: [PATCH 11/27] Copyrigtht --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 084168e..9b514d3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -65,7 +65,7 @@ # General information about the project. project = u'steelscript' -copyright = u'2020 Riverbed Technology, Inc.' +copyright = u'2019 - 2024 Riverbed Technology, Inc.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the From 40a08c8aa026f3357c9a2341bcf079caf3eea5ff Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:57:16 +0100 Subject: [PATCH 12/27] Title --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 07c4775..ce0bb48 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,7 +12,7 @@ Riverbed SteelScript for Python .. warning:: This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. -<<*outdated*>> Getting started with SteelScript 2.0 for Python 2 +<<*outdated*>> SteelScript 2.0 for Python 2 <<*outdated*>> ========================================================== Installing From 503a55cc2514de3613474720bf591c411f896581 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:01:28 +0100 Subject: [PATCH 13/27] Header --- docs/index.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index ce0bb48..1400f89 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,11 +6,12 @@ Riverbed SteelScript for Python .. note:: - Please go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ - that works in container, supports Python 3 and more. + Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + .. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. + + This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. For latest information about SteelScript that works in container, supports Python 3, notebooks and more, please refer to `SteelScript in GitHub `_ <<*outdated*>> SteelScript 2.0 for Python 2 <<*outdated*>> ========================================================== From 3f98361dda71d3beba1df531a225ad9c821c6a31 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:06:32 +0100 Subject: [PATCH 14/27] Link --- docs/index.rst | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 1400f89..c950409 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -46,7 +46,12 @@ is just one command away:: steel install --steelhead -For more details, see the :doc:`complete documentation `. +For more details, see the :doc:`doc of the steelscript module for SteelHead `. + +.. warning:: + + This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. For latest information about SteelScript that works in container, supports Python 3, notebooks and more, please refer to `SteelScript in GitHub `_ + Documentation ------------- From 58986b4e2b8aec66b8a7934a65a825463e81ef89 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:08:44 +0100 Subject: [PATCH 15/27] Header warning --- docs/index.rst | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index c950409..12f38d8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,7 +11,7 @@ Riverbed SteelScript for Python .. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. For latest information about SteelScript that works in container, supports Python 3, notebooks and more, please refer to `SteelScript in GitHub `_ + This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ <<*outdated*>> SteelScript 2.0 for Python 2 <<*outdated*>> ========================================================== @@ -48,11 +48,6 @@ is just one command away:: For more details, see the :doc:`doc of the steelscript module for SteelHead `. -.. warning:: - - This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. For latest information about SteelScript that works in container, supports Python 3, notebooks and more, please refer to `SteelScript in GitHub `_ - - Documentation ------------- From 91c10fcaa0a422326d5c17fcbc122dff84c7af5c Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:13:43 +0100 Subject: [PATCH 16/27] Refining header --- docs/index.rst | 3 +-- docs/install/docker.rst | 9 +++++++++ docs/install/linuxmac.rst | 9 +++++++++ docs/install/steelhead.rst | 9 +++++++++ docs/install/toc.rst | 9 +++++++++ docs/install/windows.rst | 9 +++++++++ 6 files changed, 46 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 12f38d8..27c0e20 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,10 +8,9 @@ Riverbed SteelScript for Python Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ - .. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ <<*outdated*>> SteelScript 2.0 for Python 2 <<*outdated*>> ========================================================== diff --git a/docs/install/docker.rst b/docs/install/docker.rst index ca1661c..63be78f 100644 --- a/docs/install/docker.rst +++ b/docs/install/docker.rst @@ -1,6 +1,15 @@ SteelScript in a Docker ====================================== +.. note:: + + Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + +.. warning:: + + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + + SteelScript for Python SDK - includes all of the core SteelScript packages in one simple container. Quickstart diff --git a/docs/install/linuxmac.rst b/docs/install/linuxmac.rst index 3810ff7..6ba77aa 100644 --- a/docs/install/linuxmac.rst +++ b/docs/install/linuxmac.rst @@ -1,6 +1,15 @@ SteelScript Installation - Linux / Mac ====================================== +.. note:: + + Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + +.. warning:: + + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + + This page provides step-by-step instructions for installing SteelScript and associated modules in the system-wide site-packages directory on a Linux or Mac. This will make SteelScript available to diff --git a/docs/install/steelhead.rst b/docs/install/steelhead.rst index 169fa40..89cb036 100644 --- a/docs/install/steelhead.rst +++ b/docs/install/steelhead.rst @@ -1,6 +1,15 @@ SteelScript SteelHead Installation ================================== +.. note:: + + Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + +.. warning:: + + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + + The SteelScript SteelHead Package is distributed entirely as Python packages via the Python Package Index `PyPI `_. This makes it easy to install diff --git a/docs/install/toc.rst b/docs/install/toc.rst index 4001b91..ba1eb52 100644 --- a/docs/install/toc.rst +++ b/docs/install/toc.rst @@ -1,6 +1,15 @@ SteelScript Installation ======================== +.. note:: + + Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + +.. warning:: + + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + + SteelScript is provided as open source on GitHub (https://github.com/riverbed). Installation of SteelScript varies depending on the platform you are using. diff --git a/docs/install/windows.rst b/docs/install/windows.rst index 186b9f6..c61b9ab 100644 --- a/docs/install/windows.rst +++ b/docs/install/windows.rst @@ -1,6 +1,15 @@ SteelScript Installation - Windows ================================== +.. note:: + + Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + +.. warning:: + + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + + This page provides step-by-step instructions for installing SteelScript and associated modules on Windows. From 971b90f694561d505dbb8c7d8ee3e1f06a09c8ce Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:17:07 +0100 Subject: [PATCH 17/27] Update --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 27c0e20..5081ce5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,7 +2,7 @@ Riverbed SteelScript for Python =============================== -`SteelScript `_ is a collection of Python modules that build upon REST APIs and other interfaces to interact with Riverbed appliances and software. +`SteelScript `_ is a collection of libraries and scripts in Python for interacting with `Riverbed `_ solutions and appliances, and other network infrastructure devices. .. note:: From 8b6c46211c1ce030779800df00d306138720c4bc Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:21:02 +0100 Subject: [PATCH 18/27] Riverbed --- docs/index.rst | 1 + docs/install/toc.rst | 7 ++++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 5081ce5..f5ea8c6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,6 +3,7 @@ Riverbed SteelScript for Python =============================== `SteelScript `_ is a collection of libraries and scripts in Python for interacting with `Riverbed `_ solutions and appliances, and other network infrastructure devices. +`SteelScript ` is provided by `Riverbed `_ as an open source project on `GitHub `_ .. note:: diff --git a/docs/install/toc.rst b/docs/install/toc.rst index ba1eb52..789e9f8 100644 --- a/docs/install/toc.rst +++ b/docs/install/toc.rst @@ -10,14 +10,15 @@ SteelScript Installation This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ -SteelScript is provided as open source on GitHub (https://github.com/riverbed). +`SteelScript ` is provided by `Riverbed `_ as an open source project on `GitHub `_ + Installation of SteelScript varies depending on the platform you are using. +The quickest and easiest installation method is probably the :doc:`Docker container `. + Start with the specific instructions for :doc:`Docker `, :doc:`Linux or Mac OS `, or :doc:`Windows ` for greater detail. -The quickest and easiest installation method is probably the :doc:`Docker container `. - Installing SteelScript SteelHead package requires executing the command ``steel install --steelhead``. But it might take a few more steps, see :doc:`SteelHead Installation Instructions ` for more details. From d5b1abe1a76da7c4754034a72d63805f67c09ebb Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:23:05 +0100 Subject: [PATCH 19/27] SteelScript on GitHub --- docs/index.rst | 4 ++-- docs/install/docker.rst | 4 ++-- docs/install/linuxmac.rst | 4 ++-- docs/install/steelhead.rst | 4 ++-- docs/install/toc.rst | 4 ++-- docs/install/windows.rst | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index f5ea8c6..ef86ab1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,11 +7,11 @@ Riverbed SteelScript for Python .. note:: - Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ .. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript on GitHub `_ <<*outdated*>> SteelScript 2.0 for Python 2 <<*outdated*>> ========================================================== diff --git a/docs/install/docker.rst b/docs/install/docker.rst index 63be78f..7486fa0 100644 --- a/docs/install/docker.rst +++ b/docs/install/docker.rst @@ -3,11 +3,11 @@ SteelScript in a Docker .. note:: - Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ .. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript on GitHub `_ SteelScript for Python SDK - includes all of the core SteelScript packages in one simple container. diff --git a/docs/install/linuxmac.rst b/docs/install/linuxmac.rst index 6ba77aa..5665345 100644 --- a/docs/install/linuxmac.rst +++ b/docs/install/linuxmac.rst @@ -3,11 +3,11 @@ SteelScript Installation - Linux / Mac .. note:: - Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ .. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript on GitHub `_ This page provides step-by-step instructions for installing diff --git a/docs/install/steelhead.rst b/docs/install/steelhead.rst index 89cb036..16cd54e 100644 --- a/docs/install/steelhead.rst +++ b/docs/install/steelhead.rst @@ -3,11 +3,11 @@ SteelScript SteelHead Installation .. note:: - Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ .. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript on GitHub `_ The SteelScript SteelHead Package is distributed entirely as diff --git a/docs/install/toc.rst b/docs/install/toc.rst index 789e9f8..eaf8355 100644 --- a/docs/install/toc.rst +++ b/docs/install/toc.rst @@ -3,11 +3,11 @@ SteelScript Installation .. note:: - Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ .. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript on GitHub `_ `SteelScript ` is provided by `Riverbed `_ as an open source project on `GitHub `_ diff --git a/docs/install/windows.rst b/docs/install/windows.rst index c61b9ab..4b4b6d8 100644 --- a/docs/install/windows.rst +++ b/docs/install/windows.rst @@ -3,11 +3,11 @@ SteelScript Installation - Windows .. note:: - Go to `SteelScript in GitHub `_ for quick starts and more about the latest `SteelScript `_ + Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ .. warning:: - This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript in GitHub `_ + This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript on GitHub `_ This page provides step-by-step instructions for installing From 1dfc3f04a6d3cd60d8f5a87e5c49484d2650d529 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:27:06 +0100 Subject: [PATCH 20/27] Tip --- docs/index.rst | 2 +- docs/install/docker.rst | 2 +- docs/install/linuxmac.rst | 8 ++++---- docs/install/steelhead.rst | 2 +- docs/install/toc.rst | 2 +- docs/install/windows.rst | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index ef86ab1..fb0108e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,7 +5,7 @@ Riverbed SteelScript for Python `SteelScript `_ is a collection of libraries and scripts in Python for interacting with `Riverbed `_ solutions and appliances, and other network infrastructure devices. `SteelScript ` is provided by `Riverbed `_ as an open source project on `GitHub `_ -.. note:: +.. tip:: Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ diff --git a/docs/install/docker.rst b/docs/install/docker.rst index 7486fa0..40c35bb 100644 --- a/docs/install/docker.rst +++ b/docs/install/docker.rst @@ -1,7 +1,7 @@ SteelScript in a Docker ====================================== -.. note:: +.. tip:: Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ diff --git a/docs/install/linuxmac.rst b/docs/install/linuxmac.rst index 5665345..f865691 100644 --- a/docs/install/linuxmac.rst +++ b/docs/install/linuxmac.rst @@ -1,7 +1,7 @@ SteelScript Installation - Linux / Mac ====================================== -.. note:: +.. tip:: Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ @@ -80,7 +80,7 @@ separate different projects from one another. $ . ~/steelscript/venv/bin/activate (venv)$ - .. note:: + .. tip:: Note how your prompt changes to include the name of the virtual environment. You can also confirm you are working within the new environment by checking which python executable is in your path:: @@ -180,7 +180,7 @@ and their dependencies instead of directly installing them. $ pip install --no-binary -d steelscript_packages steelscript.wireshark $ pip install --no-binary -d steelscript_packages virtualenv - .. note:: + .. tip:: The ``--no-binary`` option makes sure the packages can be installed on a barebones system that may not have ``pip`` available. @@ -223,7 +223,7 @@ and their dependencies instead of directly installing them. $ sudo steel install --pip-options="--no-index -f pkgs" - .. note:: + .. tip:: Omit ``sudo`` if you are using virtualenv, as admin privileges are not required diff --git a/docs/install/steelhead.rst b/docs/install/steelhead.rst index 16cd54e..78d46ae 100644 --- a/docs/install/steelhead.rst +++ b/docs/install/steelhead.rst @@ -1,7 +1,7 @@ SteelScript SteelHead Installation ================================== -.. note:: +.. tip:: Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ diff --git a/docs/install/toc.rst b/docs/install/toc.rst index eaf8355..382729c 100644 --- a/docs/install/toc.rst +++ b/docs/install/toc.rst @@ -1,7 +1,7 @@ SteelScript Installation ======================== -.. note:: +.. tip:: Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ diff --git a/docs/install/windows.rst b/docs/install/windows.rst index 4b4b6d8..bb28efa 100644 --- a/docs/install/windows.rst +++ b/docs/install/windows.rst @@ -1,7 +1,7 @@ SteelScript Installation - Windows ================================== -.. note:: +.. tip:: Go to `SteelScript on GitHub `_ for quick starts and more about the latest `SteelScript `_ From e4ac262b97f8a34dde7e3795dee272a964c91626 Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:28:57 +0100 Subject: [PATCH 21/27] Link --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index fb0108e..82f349e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,7 +3,7 @@ Riverbed SteelScript for Python =============================== `SteelScript `_ is a collection of libraries and scripts in Python for interacting with `Riverbed `_ solutions and appliances, and other network infrastructure devices. -`SteelScript ` is provided by `Riverbed `_ as an open source project on `GitHub `_ +`SteelScript `_ is provided by `Riverbed `_ as an open source project on `GitHub `_ .. tip:: From 5b88a9ffbc0790f1fdeace4dcb70c7e29daf9a5e Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Wed, 30 Oct 2024 10:31:35 +0100 Subject: [PATCH 22/27] Version --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 82f349e..9a93154 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,7 +13,7 @@ Riverbed SteelScript for Python This documentation has been created for SteelScript 2.0 at the time of Python 2 and 3.8 and has not been updated and reviewed for a while. For latest information about SteelScript that works in containers, on Linux/Mac and Windows, supports Python 3.12+, notebooks and more, please refer to `SteelScript on GitHub `_ -<<*outdated*>> SteelScript 2.0 for Python 2 <<*outdated*>> +<<*outdated*>> SteelScript 2.0 for Python 2/3.8 <<*outdated*>> ========================================================== Installing From 3671c588baa5154c719d7e6c755c70db8b21fdfe Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Thu, 31 Oct 2024 08:59:52 +0100 Subject: [PATCH 23/27] Update CHANGELOG --- CHANGELOG | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CHANGELOG b/CHANGELOG index 488e3b0..02ee2ba 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,5 +1,12 @@ CHANGELOG --------- +[24.10.1] +* Fix service issues with version (init with empty api_versions, ...) +* Add OAuth 2.0 +* Add custom payload for cookie auth +* Switch to pyreadline3 for Windows / Python 3.x +* Clean Dockerfile + [24.2.1] * Remove deprecated libs and functions (pkg_resources, datetime, gitpy_versioning) * Log warnings From c664f40011d9c70bdb539497d6dfb8246147e1ec Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Thu, 31 Oct 2024 09:46:27 +0100 Subject: [PATCH 24/27] Typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9116af0..7b57630 100644 --- a/README.md +++ b/README.md @@ -143,9 +143,9 @@ pip install git+https://github.com/riverbed/steelscript-scc ## Get SteelScript -SteelScript and modules are distributed via [Riverbed in GitHub](https://github.com/riverbed). The main repository is [SteelScript](https://github.com/riverbed/steelscript). +SteelScript and modules are distributed via [Riverbed on GitHub](https://github.com/riverbed). The main repository is [SteelScript](https://github.com/riverbed/steelscript). -To use SteelScript, it is recommended to either build your own SteelScript container or install the SteelScript modules in your own Python environment directly from the source in GitHub main repository. Refer to the quickstarts in the section above - *the guide needs update*. +To use SteelScript, it is recommended to either build your own SteelScript container or install the SteelScript modules in your own Python environment directly from the source on GitHub main repository. Refer to the quickstarts in the section above - *the guide needs update*. > [!NOTE] > Other distributions have not been maintained and contain outdated versions of SteelScript: [*outdated* SteelScript on Dockerhub](https://hub.docker.com/r/riverbed/steelscript), [*outdated* SteelScript in pypi](https://pypi.org/search/?q=steelscript), ... From 1448e99aea0d2f325a6f4ac0ca3c66de6a66d33c Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Fri, 1 Nov 2024 13:56:25 +0100 Subject: [PATCH 25/27] Link AR notebook --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7b57630..27e31a8 100644 --- a/README.md +++ b/README.md @@ -91,9 +91,9 @@ docker run --init --rm -p 8888:8888 --name=steelscript.notebook steelscript.note In the output, grab the url containing the *token*, for example *http://127.0.0.1:8888/tree?token=123456* , and open it in your browser to log into the Jupyter web-console. -From there, in the *Notebooks* folder you can find some notebook based on SteelScript: +From there, in the *Notebooks* folder you can find some notebooks based on SteelScript: -* **AppResponse**: 01-appresponse-hostgroups.ipynb +* **AppResponse**: [01-appresponse-hostgroups.ipynb](https://github.com/riverbed/steelscript-appresponse/blob/master/notebooks/01-appresponse-hostgroups.ipynb) * *work in progress* NetProfiler From cc62d15337dca193380eafb73ca571e32532029b Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Fri, 1 Nov 2024 15:57:31 +0100 Subject: [PATCH 26/27] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 27e31a8..f291768 100644 --- a/README.md +++ b/README.md @@ -214,6 +214,7 @@ The repos of SteelScript modules have a common structure │ └── __init__.py ├── tests ├── setup.py + ├── examples ├── notebooks └── tox.ini ``` @@ -224,7 +225,7 @@ Mandatory: - LICENSE: Riverbed Technology copyright, terms and conditions based on MIT - CHANGELOG: Simple text file tracking major changes - /docs: Documentation using reStructured Text (rst) file format. -- /examples: Python scripts samples showing how to use the module +- /examples: Python scripts samples showing how to use the module (only .py files) - /steelscript: The actual code, written in Python (Python 3). - /tests: Test plans and unit test. Can be organized in subfolders. Test plan are ideally documented and easy to run scripts but can be anything defining a test plan (script, text, ...), for example a Python script based on pytest. - setup.py: Python setup file containing meta descriptions and requirements. Based on setuptools, distutils and pytest. Should NOT contain unit test (use Tox and put unit test inside /tests folder instead) From 2702a4a6e196026af20ce237b7af881a7c548d2a Mon Sep 17 00:00:00 2001 From: Gwen Blum <19484478+gwenblum@users.noreply.github.com> Date: Fri, 1 Nov 2024 20:56:32 +0100 Subject: [PATCH 27/27] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f291768..97c36ab 100644 --- a/README.md +++ b/README.md @@ -6,12 +6,12 @@ Riverbed SteelScript is a collection of libraries and scripts written in Python ## Quick Start -Here are 4 things you can do to start quick and easy with SteelScript. +Here are 4 things you can do to start quick and easy with SteelScript (click to expand the section).
Try examples just with git and Docker -### Quick Start SteelScript examples in a container +### Quick start SteelScript examples in a container If you have [git](https://git-scm.com/downloads) and [Docker](https://www.docker.com/get-started) installed, for example on a Linux machine in your lab. @@ -101,7 +101,7 @@ From there, in the *Notebooks* folder you can find some notebooks based on Steel
Try SteelScript notebooks in your own SteelScript environment, just with python, pip, git and vscode -### Quick Start SteelScript notebooks in your environment +### Quick start SteelScript notebooks in your environment If you have all the tools ready: 1. [Python](https://www.python.org/downloads) and pip