Skip to content

Commit

Permalink
Merge pull request #2877 from locustio/document-use-with-uvx-and-remo…
Browse files Browse the repository at this point in the history
…ve-openssl-version-from--V-output

Document use with uvx and remove openssl version from  --version output
  • Loading branch information
cyberw authored Aug 30, 2024
2 parents 44f15db + 169a62b commit 8fbb2bc
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 5 deletions.
35 changes: 31 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@
Installation
============

0. `Install Python <https://docs.python-guide.org/starting/installation/>`_ (3.9 or later)
Using system-installed Python and pip
-------------------------------------

1. Install the package (check `Troubleshooting Installation`_ if the installation fails)
0. `Install Python <https://docs.python-guide.org/starting/installation/>`_ (if you dont already have it)

1. Install Locust

.. code-block:: console
Expand All @@ -17,9 +20,33 @@ Installation
:substitutions:
$ locust -V
locust |version| from /usr/local/lib/python3.10/site-packages/locust (python 3.10.6)
locust |version| from /usr/local/lib/python3.12/site-packages/locust (Python 3.12.5)
Using uvx
---------

0. `Install uv <https://github.com/astral-sh/uv?tab=readme-ov-file#installation>`_

1. Install and run locust in an ephemeral environment

.. code-block:: console
:substitutions:
$ uvx locust -V
locust |version| from /.../uv/.../locust (Python 3.12.5)
.. note::

Check `Troubleshooting Installation`_ if you encounter issues.


Done!
-----

Now you can :ref:`create and run your first test <quickstart>`

3. Done! Now you can :ref:`create your first test <quickstart>`
-----------------


Pre-release builds
Expand Down
2 changes: 1 addition & 1 deletion locust/argument_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -715,7 +715,7 @@ def setup_parser_arguments(parser):
"-V",
action="version",
help="Show program's version number and exit",
version=f"locust {version} from {os.path.dirname(__file__)} (Python {platform.python_version()}, {' '.join(ssl.OPENSSL_VERSION.split(' ')[0:2])})",
version=f"locust {version} from {os.path.dirname(__file__)} (Python {platform.python_version()})",
)
other_group.add_argument(
"--exit-code-on-error",
Expand Down

0 comments on commit 8fbb2bc

Please sign in to comment.