From 08cbf41311e779a43113272e7ccf3c7baf866f70 Mon Sep 17 00:00:00 2001
From: Jack Atkinson <jwa34@cam.ac.uk>
Date: Thu, 23 Jan 2025 08:42:55 +0000
Subject: [PATCH 1/2] Typo fix in optional dependency install and consolidate
to bash syntax rather than a mix of zsh sytnax.
---
README.md | 5 +++--
docs/getting-started/installation.rst | 8 +++++---
2 files changed, 8 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 759ee3b..2215346 100644
--- a/README.md
+++ b/README.md
@@ -45,10 +45,11 @@ It is recommended to use a virtual environment.
If you want a local install that you can edit instead, clone the repository,
navigate to `archeryutils/`, and run:
- python3 -m pip install -e .[test,lint,docs]
+ python3 -m pip install -e .
Please refer to the online documentation for
-[full installation guidance](https://archeryutils.readthedocs.io/en/latest/getting-started/installation.html).
+[full installation guidance](https://archeryutils.readthedocs.io/en/latest/getting-started/installation.html)
+including optional dependencies for developing and testing.
### Getting Started
There are examples of some of the different functionalities in the jupyter notebook
diff --git a/docs/getting-started/installation.rst b/docs/getting-started/installation.rst
index 74eb717..d495c55 100644
--- a/docs/getting-started/installation.rst
+++ b/docs/getting-started/installation.rst
@@ -27,7 +27,7 @@ install as an editable package::
git clone git@github.com:jatkinson1000/archeryutils.git
cd archeryutils
- pip install -e .[test,int,docs]
+ pip install -e .[test,lint,docs]
Testing
~~~~~~~
@@ -35,7 +35,7 @@ Testing
To run tests on a development installation either install
`pytest <https://docs.pytest.org/>`__ using pip, or install as an optional dependency::
- pip install -e ".[test]"
+ pip install -e .[test]
and then run::
@@ -54,6 +54,8 @@ lint
For applying quality control to the code::
+ pip install -e .[lint]
+
* ruff (0.7.3 or later)
* mypy (1.0.0 or later)
* coverage
@@ -66,7 +68,7 @@ docs
For building documentation::
- pip install -e ".[docs]"
+ pip install -e .[docs]
* sphinx
* sphinx_rtd_theme
From a4832e31297e5a39ad07997e8292a1d719cceebb Mon Sep 17 00:00:00 2001
From: Jack Atkinson <jwa34@cam.ac.uk>
Date: Thu, 23 Jan 2025 08:55:09 +0000
Subject: [PATCH 2/2] add a note to installation docs for zsh users.
---
docs/getting-started/installation.rst | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/docs/getting-started/installation.rst b/docs/getting-started/installation.rst
index d495c55..52cc4e4 100644
--- a/docs/getting-started/installation.rst
+++ b/docs/getting-started/installation.rst
@@ -29,6 +29,13 @@ install as an editable package::
cd archeryutils
pip install -e .[test,lint,docs]
+.. note::
+ If you are installing in zsh you will need to use quotes for the optional dependencies:
+
+ .. code-block:: bash
+
+ pip install -e '.[test,lint,docs]'
+
Testing
~~~~~~~