From 728f62695621a9d84293ea06413aed5669df414d Mon Sep 17 00:00:00 2001 From: Michael Wayne Goodman Date: Tue, 5 Dec 2023 21:49:14 -0800 Subject: [PATCH] Update installation instructions - Trim down prose around conda-forge - Add conda install instructions to docs - Change wn[web] to "wn[web]" to be zsh compatible --- README.md | 24 +++++++++--------------- docs/api/wn.web.rst | 2 +- docs/setup.rst | 13 ++++++++++++- 3 files changed, 22 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index ebdde1b..de4ee3c 100644 --- a/README.md +++ b/README.md @@ -20,36 +20,30 @@ --- -Wn is a Python library for exploring information in wordnets. +Wn is a Python library for exploring information in wordnets. ## Installation -Install it from PyPI using **pip** and download some data: +Install it from PyPI using **pip**: ```sh pip install wn -python -m wn download oewn:2023 # the Open # English WordNet 2023 ``` -Or, install using **conda**, from conda-forge channel: +Or install using **conda** from the conda-forge channel +([conda-forge/wn-feedstock](https://github.com/conda-forge/wn-feedstock)): ```sh conda install -c conda-forge wn ``` -
-🔔 Click to see details on the conda-forge packaging repository (feedstock) -

+## Getting Started -> ℹī¸ The conda-forge recipe for this python library is maintained at the -> following conda-forge **feedstock** repository. -> -> - **Feedstock**: - -

-
+First, download some data: -## Getting Started +```sh +python -m wn download oewn:2023 # the Open # English WordNet 2023 +``` Now start exploring: diff --git a/docs/api/wn.web.rst b/docs/api/wn.web.rst index 18e199a..22ce28d 100644 --- a/docs/api/wn.web.rst +++ b/docs/api/wn.web.rst @@ -75,7 +75,7 @@ module. Install them with the ``[web]`` extra: .. code-block:: bash - $ pip install wn[web] + $ pip install "wn[web]" Running and Deploying the Server diff --git a/docs/setup.rst b/docs/setup.rst index 9fcff25..88c5f87 100644 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -21,7 +21,18 @@ installation extra: .. code-block:: bash - pip install wn[web] + pip install "wn[web]" + + +Installing with Conda +--------------------- + +Alternatively, if you use the `Anaconda ` +distribution of Python, you can install with conda: + +.. code-block:: bash + + conda install -c conda-forge wn The Data Directory