Skip to content

Commit

Permalink
Add installation instructions for homebrew formula
Browse files Browse the repository at this point in the history
  • Loading branch information
nat-n committed Oct 2, 2023
1 parent 0c75767 commit f500668
Showing 1 changed file with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,17 @@ Or using pip:
pip install poethepoet
The :sh:`poe` executable will then be available anywhere in your system.
The ``poe`` executable will then be available anywhere in your system.

2. Install Poe the Poet into your poetry project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2. Install the CLI globally using |brew_link|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: sh
The ``poe`` CLI is also available as a |formula_link| to be installed globally:

poetry add --group dev poethepoet
.. code-block:: sh
The :sh:`poe` executable will then be available when inside a :sh:`poetry shell` or as :sh:`poetry run poe`.
brew tap nat-n/poethepoet
brew install nat-n/poethepoet/poethepoet
3. Install Poe the Poet as a poetry plugin
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -41,6 +42,16 @@ It'll then be available as the :sh:`poetry poe` command anywhere in your system.

See the :doc:`poetry plugin docs <poetry_plugin>` for more details about this option.


4. Install Poe the Poet into your poetry project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: sh
poetry add --group dev poethepoet
The :sh:`poe` executable will then be available when inside a :sh:`poetry shell` or as :sh:`poetry run poe`.

.. tip::

If you prefer not to install poe globally, then you might want to create for yourself an alias such like :sh:`alias poe="poetry run poe"` or :sh:`alias poe="poetry poe"`, which should enable you to still benefit from tab completion.
Expand Down Expand Up @@ -108,3 +119,11 @@ macOS, linux and windows.

<a href="https://pypa.github.io/pipx/" target="_blank">pipx</a>

.. |brew_link| raw:: html

<a href="https://brew.sh/" target="_blank">homebrew</a>

.. |formula_link| raw:: html

<a href="https://github.com/nat-n/homebrew-poethepoet" target="_blank">homebrew formula</a>

0 comments on commit f500668

Please sign in to comment.