RomanNum3ral
/
scrapy
mirror of https://github.com/scrapy/scrapy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4309 from Gallaecio/virtualenv-doc 

Update installation instructions regarding Python 3 and virtual environments
This commit is contained in:
Mikhail Korobov 2020-02-18 19:56:35 +05:00 committed by GitHub
parent 2d6d4fb233 59653ebac6
commit 320cea62ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/intro/install.rst
View File

@ -81,35 +81,18 @@ Python packages can be installed either globally (a.k.a system wide),
or in user-space. We do not recommend installing Scrapy system wide. or in user-space. We do not recommend installing Scrapy system wide.
Instead, we recommend that you install Scrapy within a so-called Instead, we recommend that you install Scrapy within a so-called
"virtual environment" (`virtualenv`_). "virtual environment" (:mod:`venv`).
Virtualenvs allow you to not conflict with already-installed Python Virtual environments allow you to not conflict with already-installed Python
system packages (which could break some of your system tools and scripts), system packages (which could break some of your system tools and scripts),
and still install packages normally with ``pip`` (without ``sudo`` and the likes). and still install packages normally with ``pip`` (without ``sudo`` and the likes).
To get started with virtual environments, see `virtualenv installation instructions`_. See :ref:`tut-venv` on how to create your virtual environment.
To install it globally (having it globally installed actually helps here),
it should be a matter of running::
$ [sudo] pip install virtualenv Once you have created a virtual environment, you can install Scrapy inside it with ``pip``,
Check this `user guide`_ on how to create your virtualenv.
.. note::
If you use Linux or OS X, `virtualenvwrapper`_ is a handy tool to create virtualenvs.
Once you have created a virtualenv, you can install Scrapy inside it with ``pip``,
just like any other Python package. just like any other Python package.
(See :ref:`platform-specific guides <intro-install-platform-notes>` (See :ref:`platform-specific guides <intro-install-platform-notes>`
below for non-Python dependencies that you may need to install beforehand). below for non-Python dependencies that you may need to install beforehand).
Python virtualenvs can be created to use Python 2 by default, or Python 3 by default. As Scrapy
only supports Python 3, make sure you created a Python 3 virtualenv.
.. _virtualenv: https://virtualenv.pypa.io
.. _virtualenv installation instructions: https://virtualenv.pypa.io/en/stable/installation/
.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/install.html
.. _user guide: https://virtualenv.pypa.io/en/stable/userguide/
.. _intro-install-platform-notes: .. _intro-install-platform-notes:
@ -205,15 +188,12 @@ solutions:
brew update; brew upgrade python brew update; brew upgrade python
* *(Optional)* Install Scrapy inside an isolated python environment. * *(Optional)* :ref:`Install Scrapy inside a Python virtual environment
<intro-using-virtualenv>`.
This method is a workaround for the above OS X issue, but it's an overall This method is a workaround for the above OS X issue, but it's an overall
good practice for managing dependencies and can complement the first method. good practice for managing dependencies and can complement the first method.
`virtualenv`_ is a tool you can use to create virtual environments in python.
We recommended reading a tutorial like
http://docs.python-guide.org/en/latest/dev/virtualenvs/ to get started.
After any of these workarounds you should be able to install Scrapy:: After any of these workarounds you should be able to install Scrapy::
pip install Scrapy pip install Scrapy