From 3a3e4daf6076fd7d5057fa6890b4c73c9511003a Mon Sep 17 00:00:00 2001 From: Adriane Boyd Date: Tue, 2 Feb 2021 14:44:15 +0100 Subject: [PATCH 1/2] Update install instructions * Remove duplicate section about compiling from source --- website/docs/usage/index.md | 30 ------------------------------ 1 file changed, 30 deletions(-) diff --git a/website/docs/usage/index.md b/website/docs/usage/index.md index 2df8cdaa0..4e29fd959 100644 --- a/website/docs/usage/index.md +++ b/website/docs/usage/index.md @@ -264,36 +264,6 @@ You can configure the build process with the following environment variables: | `PYVER` | The Python version to build against. This version needs to be available on your build and runtime machines. Defaults to `3.6`. | | `WHEELHOUSE` | Directory to store the wheel files during compilation. Defaults to `./wheelhouse`. | -#### Additional options for developers {#source-developers} - -Some additional options may be useful for spaCy developers who are editing the -source code and recompiling frequently. - -- Install in editable mode. Changes to `.py` files will be reflected as soon as - the files are saved, but edits to Cython files (`.pxd`, `.pyx`) will require - the `pip install` or `python setup.py build_ext` command below to be run - again. Before installing in editable mode, be sure you have removed any - previous installs with `pip uninstall spacy`, which you may need to run - multiple times to remove all traces of earlier installs. - - ```diff - pip install -U pip setuptools wheel - - pip install . - + pip install -r requirements.txt - + pip install --no-build-isolation --editable . - ``` - -- Build in parallel using `N` CPUs to speed up compilation and then install in - editable mode: - - ```diff - pip install -U pip setuptools wheel - - pip install . - + pip install -r requirements.txt - + python setup.py build_ext --inplace -j N - + python setup.py develop - ``` - ### Run tests {#run-tests} spaCy comes with an [extensive test suite](%%GITHUB_SPACY/spacy/tests). In order From 37a68a06ab7928ae2184104e0a45c240980ed6d4 Mon Sep 17 00:00:00 2001 From: Adriane Boyd Date: Tue, 2 Feb 2021 16:51:27 +0100 Subject: [PATCH 2/2] Update to recommend editable installs for source installs --- README.md | 12 +++--------- website/docs/usage/index.md | 19 +++++-------------- 2 files changed, 8 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 9bdb83bae..6a35e19c5 100644 --- a/README.md +++ b/README.md @@ -253,20 +253,14 @@ source .env/bin/activate # make sure you are using the latest pip 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: ```bash -pip install .[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 +pip install --no-build-isolation --editable .[lookups,cuda102] ``` ## 🚦 Run tests diff --git a/website/docs/usage/index.md b/website/docs/usage/index.md index 4e29fd959..cbbda2e4f 100644 --- a/website/docs/usage/index.md +++ b/website/docs/usage/index.md @@ -170,26 +170,17 @@ $ git clone https://github.com/explosion/spaCy # clone spaCy $ cd spaCy # navigate into dir $ python -m venv .env # create environment in .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: ```bash -$ pip install .[lookups,cuda102] # install spaCy with extras +$ pip install --no-build-isolation --editable .[lookups,cuda102] ``` -To install all dependencies required for development: - -```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. +How to install compilers and related build tools: @@ -227,7 +218,7 @@ source code and recompiling frequently. ```bash $ pip install -r requirements.txt $ python setup.py build_ext --inplace -j N - $ pip install --no-build-isolation --editable . + $ python setup.py develop ``` ### Building an executable {#executable}