From 493712aadf8a753aac03c1fe14e1d486bdc75162 Mon Sep 17 00:00:00 2001 From: s-pace Date: Fri, 2 Nov 2018 18:20:31 +0100 Subject: [PATCH] give instructions regarding how to use our scraper without docker closes algolia/docsearch#449 --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7f5de178..79c33dfd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,16 @@ Hello you, + +## Install the scrapper without Docker + +We do recommend the use of [pipenv][1] to install the whole python environment + +- [Install pipenv][2] +- `pipenv --python 2.7 install` + +You should be ready to go. + + ## Run the tests To run the full test suite, run `./docsearch test`. Note that it requires that @@ -42,4 +53,6 @@ git clone git@github.com:algolia/docsearch-configs.git configs/public ``` The CLI will then have more commands for you to run. +[1]: https://github.com/pypa/pipenv +[2]: https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv