Skip to content

Commit

Permalink
Update README.rst with new example folder
Browse files Browse the repository at this point in the history
For example for AppResponse, the `examples` and notebooks folder inside a steelscript workspace dir are:

* examples/steelscript-appresponse (instead of examples/appresponse-examples)
* notebooks/steelscript-appresponse (instead of notebooks/appresponse-notebooks)

-> where steelscript-appresponse is the name of the steelscript module
  • Loading branch information
gwenblum authored Sep 26, 2024
1 parent 1f24cc8 commit de1e3f9
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,19 @@ From here you can start to use the SteelScript framework. You can try some scrip

.. code:: shell
python examples/appresponse-examples/print_hostgroups-formatted.py {appresponse fqdn or IP address} -u {admin account} -p {password}
python examples/steelscript-appresponse/print_hostgroups-formatted.py {appresponse fqdn or IP address} -u {admin account} -p {password}
2. Get the licenses and services of a Client Accelerator Controller appliance:

.. code:: shell
python examples/cacontroller-examples/cacontroller-rest_api.py {client accelerator controller fqdn or IP address} --access_code {access_code}
python examples/steelscript-cacontroller/cacontroller-rest_api.py {client accelerator controller fqdn or IP address} --access_code {access_code}
3. List the devices from NetIM Core:

.. code:: shell
python examples/netim-examples/print-netim-devices-raw.py {netim core fqdn or IP address} --username {account} --password {password}
python examples/steelscript-netim/print-netim-devices-raw.py {netim core fqdn or IP address} --username {account} --password {password}
Run examples with Jupyter Notebook
Expand All @@ -67,7 +67,7 @@ Run the container with Jupyter Notebook server, by default on port 8888
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 examples based on SteelScript.
From there, in the *Notebooks* folder you can find some notebook based on SteelScript.

Guide
-------------------------
Expand Down Expand Up @@ -139,7 +139,7 @@ The repos of SteelScript modules have a common structure
├── CHANGELOG
├── .gitignore
├── docs
├── examples
├──
├── steelscript
│ ├── __init__.py
│ └── module-name # for example: appresponse
Expand All @@ -160,7 +160,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.
- /: Python scripts samples showing how to use the module.
- /steelscript: The actual code, written in Python. Must be Python3 only.
- /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, gitpy-versioning (custom versioning tool https://github.com/riverbed/gitpy-versioning) and pytest. Should NOT contain unit test (use Tox and put unit test inside /tests folder instead)
Expand Down

0 comments on commit de1e3f9

Please sign in to comment.