Update to recommend editable installs for source installs

This commit is contained in:
Adriane Boyd 2021-02-02 16:51:27 +01:00
parent 3a3e4daf60
commit 37a68a06ab
2 changed files with 8 additions and 23 deletions

View File

@ -253,20 +253,14 @@ source .env/bin/activate
# make sure you are using the latest pip # make sure you are using the latest pip
python -m pip install -U pip setuptools wheel python -m pip install -U pip setuptools wheel
pip install . pip install -r requirements.txt
pip install --no-build-isolation --editable .
``` ```
To install with extras: To install with extras:
```bash ```bash
pip install .[lookups,cuda102] pip install --no-build-isolation --editable .[lookups,cuda102]
```
To install all dependencies required for development, use the [`requirements.txt`](requirements.txt). Compared to regular install via pip, it
additionally installs developer dependencies such as Cython.
```bash
pip install -r requirements.txt
``` ```
## 🚦 Run tests ## 🚦 Run tests

View File

@ -170,26 +170,17 @@ $ git clone https://github.com/explosion/spaCy # clone spaCy
$ cd spaCy # navigate into dir $ cd spaCy # navigate into dir
$ python -m venv .env # create environment in .env $ python -m venv .env # create environment in .env
$ source .env/bin/activate # activate virtual env $ source .env/bin/activate # activate virtual env
$ pip install . # compile and install spaCy $ pip install -r requirements.txt # install requirements
$ pip install --no-build-isolation --editable . # compile and install spaCy
``` ```
To install with extras: To install with extras:
```bash ```bash
$ pip install .[lookups,cuda102] # install spaCy with extras $ pip install --no-build-isolation --editable .[lookups,cuda102]
``` ```
To install all dependencies required for development: How to install compilers and related build tools:
```bash
$ pip install -r requirements.txt
```
Compared to a regular install via pip, the
[`requirements.txt`](%%GITHUB_SPACY/requirements.txt) additionally includes
developer dependencies such as Cython and the libraries required to run the test
suite. See the [quickstart widget](#quickstart) to get the right commands for
your platform and Python version.
<a id="source-ubuntu"></a><a id="source-osx"></a><a id="source-windows"></a> <a id="source-ubuntu"></a><a id="source-osx"></a><a id="source-windows"></a>
@ -227,7 +218,7 @@ source code and recompiling frequently.
```bash ```bash
$ pip install -r requirements.txt $ pip install -r requirements.txt
$ python setup.py build_ext --inplace -j N $ python setup.py build_ext --inplace -j N
$ pip install --no-build-isolation --editable . $ python setup.py develop
``` ```
### Building an executable {#executable} ### Building an executable {#executable}