Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC-585: starting connext version-specific connector-py instructions #192

Merged
merged 2 commits into from
Nov 27, 2024
Merged

DOC-585: starting connext version-specific connector-py instructions #192

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0af1f49
DOC-585: starting connext version-specific connector-py instructions
Nov 8, 2024
7ff0c9a
DOC-585: incorporating reviewer feedback into Connector Python versio…
Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions docs/getting_started.rst
View file
Open in desktop
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
Copy link
Collaborator Author

@rkorte rkorte Nov 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obviously, these are not the right instructions. I do not know what the right instructions are. Elaine told me Connector-py needs the same changes that we made to Connector-js and to the Connext Python API regarding versions. So, @Alxe, please tell me what we should really say here (feel free to make changes in the branch if you prefer).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pip documentation is accurate, but I'd prefer using rticonnextdds-connector (both are valid) so that it matches JS documentation.

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