Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update installation instructions #196

Merged
merged 1 commit into from
Dec 6, 2023
Merged

Update installation instructions #196

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 9 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<details>
<summary><strong>🔔 Click to see details on the conda-forge packaging repository (feedstock)</strong></summary>
<p>
## Getting Started

> ℹ️ The conda-forge recipe for this python library is maintained at the
> following conda-forge **feedstock** repository.
>
> - **Feedstock**: <https://github.com/conda-forge/wn-feedstock>

</p>
</details>
First, download some data:

## Getting Started
```sh
python -m wn download oewn:2023 # the Open # English WordNet 2023
```

Now start exploring:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/wn.web.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 12 additions & 1 deletion docs/setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://anaconda.org/>`
distribution of Python, you can install with conda:

.. code-block:: bash

conda install -c conda-forge wn


The Data Directory
Expand Down