Skip to content

Commit

Permalink
Merge pull request #192 from rticommunity/doc/DOC-585
Browse files Browse the repository at this point in the history
DOC-585: starting connext version-specific connector-py instructions
  • Loading branch information
rkorte authored Nov 27, 2024
2 parents c5aa5cf + 7ff0c9a commit c35ee99
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,29 @@ Getting Started
Installing RTI Connector for Python
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

There are two ways to obtain *RTI Connector* for Python. You can install it with
*pip*:
Install *RTI Connector for Python* with *pip*:

.. code:: bash
$ pip install rticonnextdds_connector
$ pip install rticonnextdds-connector
And then run your *Connector* applications:
The above command installs the latest version of *Connext* by default. To
install a specific version, use this command:

.. code:: bash
.. code-block:: console
$ python my_connector_app.py
$ pip install rticonnextdds-connector==<version>
You can also clone the repository and run the examples directly without installing
*Connector*:
where ``<version>`` is any valid *Connext* version in the
`Release history <https://pypi.org/project/rticonnextdds-connector/#history>`__
at pypi.org.

And then run your *Connector* applications:

.. code:: bash
$ git clone --recursive https://github.com/rticommunity/rticonnextdds-connector-py.git
$ python my_connector_app.py
In order to access the examples, clone the github repository.
Running the examples
~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit c35ee99

Please sign in to comment.