Merge pull request #373 from robotology/feature/scenario_pypi

Update the PyPI name to `scenario`

.github/workflows/cicd.yml

@@ -264,7 +264,7 @@ jobs:
             build_ext -DIGNITION_DISTRIBUTION=$(python3 -c "print('${{ matrix.ignition }}'.capitalize())")
       - name: '[👤|user] Install local wheel'
         if: matrix.type == 'User'
-        run: pip install -v dist/scenar_io-*.whl
+        run: pip install -v dist/scenario-*.whl
 
       - name: '🔍️ Inspect installed ScenarIO package'
         if: matrix.type == 'User' && contains(matrix.os, 'ubuntu')
@@ -313,7 +313,7 @@ jobs:
 
       - name: '🗑️ Remove external wheels'
         if: matrix.type == 'User'
-        run: find dist/ -type f -not -name 'scenar_io-*' -delete -print
+        run: find dist/ -type f -not -name 'scenario-*' -delete -print
 
       # We have to trick PyPI that our wheels are manylinux2014 even if they are not.
       # Unfortunately we cannot create self-contained wheels (neither the PEP600 perennial)
@@ -472,7 +472,7 @@ jobs:
       # ================
 
       - name: '🗑️ Remove external packages'
-        run: find dist/ -type f -not \( -name '*scenar_io-*' -o -name '*gym_ignition-*' \) -delete -print
+        run: find dist/ -type f -not \( -name '*scenario-*' -o -name '*gym_ignition-*' \) -delete -print
 
       - name: '🔍 Check packages'
         run: pipx run twine check dist/*

docs/sphinx/installation/developer.rst

@@ -73,6 +73,6 @@ to install it again.
     The ``scenario`` editable installation is just a placeholder.
     It is necessary to prevent the editable installation of ``gym-ignition`` to override the resources installed by
     the manual CMake execution.
-    Otherwise, the ``scenar-io`` package from PyPI would be pulled, resulting with a wrong version.
+    Otherwise, the ``scenario`` package from PyPI would be pulled, resulting with a wrong version.
 
 .. include:: system_configuration.rst

docs/sphinx/installation/nightly.rst

@@ -16,20 +16,20 @@ PyPI Package
 We provide two different packages for ScenarIO and gym-ignition.
 
 If you are interested in the ScenarIO package,
-install the `scenar-io <https://pypi.org/project/scenar-io/>`_ package from PyPI:
+install the `scenario <https://pypi.org/project/scenario/>`_ package from PyPI:
 
 .. code-block:: bash
 
-   pip install --pre scenar-io
+   pip install --pre scenario
 
 Instead, if you are interested in gym-ignition,
 install the `gym-ignition <https://pypi.org/project/gym-ignition/>`_ package from PyPI:
 
 .. code-block:: bash
 
-   pip install --pre scenar-io gym-ignition
+   pip install --pre scenario gym-ignition
 
-Note that in this case, specifying also the ``scenar-io`` dependency is necessary,
+Note that in this case, specifying also the ``scenario`` dependency is necessary,
 otherwise ``pip`` will pull the stable package from PyPI.
 
 .. include:: system_configuration.rst

docs/sphinx/installation/stable.rst

@@ -16,11 +16,11 @@ PyPI Package
 We provide two different packages for ScenarIO and gym-ignition.
 
 If you are interested in the ScenarIO package,
-install the `scenar-io <https://pypi.org/project/scenar-io/>`_ package from PyPI:
+install the `scenario <https://pypi.org/project/scenario/>`_ package from PyPI:
 
 .. code-block:: bash
 
-   pip install scenar-io
+   pip install scenario
 
 Instead, if you are interested in gym-ignition,
 install the `gym-ignition <https://pypi.org/project/gym-ignition/>`_ package from PyPI:
@@ -29,4 +29,4 @@ install the `gym-ignition <https://pypi.org/project/gym-ignition/>`_ package fro
 
    pip install gym-ignition
 
-It will download and install also ``scenar-io`` since it depends on it.
+It will download and install also ``scenario`` since it depends on it.

scenario/README.md

@@ -5,13 +5,13 @@
 [![Lines](https://img.shields.io/tokei/lines/github/robotology/gym-ignition)][gym-ignition]
 [![Python CI/CD](https://github.com/robotology/gym-ignition/workflows/CI/CD/badge.svg)](https://github.com/robotology/gym-ignition/actions)
 
-[![Version](https://img.shields.io/pypi/v/scenar-io.svg)][pypi]
-[![Python versions](https://img.shields.io/pypi/pyversions/scenar-io.svg)][pypi]
-[![Status](https://img.shields.io/pypi/status/scenar-io.svg)][pypi]
-[![Format](https://img.shields.io/pypi/format/scenar-io.svg)][pypi]
-[![License](https://img.shields.io/pypi/l/scenar-io.svg)][pypi]
+[![Version](https://img.shields.io/pypi/v/scenario.svg)][pypi]
+[![Python versions](https://img.shields.io/pypi/pyversions/scenario.svg)][pypi]
+[![Status](https://img.shields.io/pypi/status/scenario.svg)][pypi]
+[![Format](https://img.shields.io/pypi/format/scenario.svg)][pypi]
+[![License](https://img.shields.io/pypi/l/scenario.svg)][pypi]
 
-[pypi]: https://pypi.org/project/scenar-io/
+[pypi]: https://pypi.org/project/scenario/
 [gym-ignition]: https://github.com/robotology/gym-ignition
 [scenario]: https://github.com/robotology/gym-ignition/tree/master/scenario
 
@@ -69,7 +69,7 @@ Then, install the supported Ignition suite following the
 Execute, preferably in a [virtual environment](https://docs.python.org/3.8/tutorial/venv.html):
 
 ```bash
-pip install scenar-io
+pip install scenario
 ```
 
 ### C++

scenario/setup.cfg

@@ -3,7 +3,7 @@
 # GNU Lesser General Public License v2.1 or any later version.
 
 [metadata]
-name = scenar_io
+name = scenario
 description = SCENe interfAces for Robot Input/Output.
 long_description = file: README.md
 long_description_content_type = text/markdown

setup.cfg

@@ -58,7 +58,7 @@ package_dir =
     =python
 python_requires = >=3.8
 install_requires =
-    scenar_io
+    scenario
     gym>=0.13.1
     numpy
     scipy