Skip to content

Commit

Permalink
Document use with uvx
Browse files Browse the repository at this point in the history
  • Loading branch information
cyberw committed Aug 30, 2024
1 parent d5b0cd1 commit cca42e1
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 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 @@ -19,15 +22,29 @@ Installation
$ locust -V
locust |version| from /usr/local/lib/python3.12/site-packages/locust (Python 3.12.5)
3. Done! Now you can :ref:`create your first test <quickstart>`
Or, using `uvx <https://github.com/astral-sh/uv?tab=readme-ov-file#installation>`_, you can run it in an ephemeral environment:
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/.../python3.12/site-packages/locust (Python 3.12.5)
locust |version| from /.../uv/.../locust (Python 3.12.5)
.. note::

Check `Troubleshooting Installation`_ if you encounter issues.


Done!
-----

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

Pre-release builds
------------------
Expand Down

0 comments on commit cca42e1

Please sign in to comment.