Commit fff0af36 authored by Jason Madden's avatar Jason Madden

Notes about cython on windows. XXX: Duplicated a couple places, intro.rst and...

Notes about cython on windows. XXX: Duplicated a couple places, intro.rst and README.rst, we should refactor.
parent 17d6f42f
...@@ -39,9 +39,15 @@ To install one of these release candidates, you can run:: ...@@ -39,9 +39,15 @@ To install one of these release candidates, you can run::
pip install --pre gevent pip install --pre gevent
.. tip:: On Windows, if you install from the sdist instead of a
binary wheel, you will need to have ``cython`` installed
*before* you attempt to install gevent. Most users will
use the binary wheel and can ignore this.
Download the latest release from `Python Package Index`_ or clone `the repository`_. Download the latest release from `Python Package Index`_ or clone `the repository`_.
Read the documentation online at http://www.gevent.org Read the documentation online at http://www.gevent.org. Additional
installation information can be found `here <http://www.gevent.org/intro.html#installation-and-requirements>`_.
Post feedback and issues on the `bug tracker`_, `mailing list`_, blog_ Post feedback and issues on the `bug tracker`_, `mailing list`_, blog_
and `twitter (@gevent)`_. and `twitter (@gevent)`_.
...@@ -63,6 +69,7 @@ To hack on gevent (using a virtualenv):: ...@@ -63,6 +69,7 @@ To hack on gevent (using a virtualenv)::
(env) $ pip install -r dev-requirements.txt (env) $ pip install -r dev-requirements.txt
.. note:: .. note::
You must have Cython, a C compiler, and the Python You must have Cython, a C compiler, and the Python
development headers installed to build a checkout. Installing CFFI development headers installed to build a checkout. Installing CFFI
on CPython (it's standard on PyPy) allows building the CFFI backend on CPython (it's standard on PyPy) allows building the CFFI backend
......
...@@ -53,6 +53,15 @@ addition to the Cython backend on CPython. ...@@ -53,6 +53,15 @@ addition to the Cython backend on CPython.
another directory. See :issue:`570` and :issue:`612` for another directory. See :issue:`570` and :issue:`612` for
examples. examples.
.. tip:: On Windows, if you install from the PyPI sdist instead of a
binary wheel, you will need to have ``cython`` installed
*before* you attempt to install gevent. (Cython is always
required when working from a source checkout.) Most users will
use the binary wheel and can ignore this.
Development instructions can be found `on PyPI <https://pypi.python.org/pypi/gevent#development>`_.
__ http://pypi.python.org/pypi/greenlet __ http://pypi.python.org/pypi/greenlet
.. _`pip`: https://pip.pypa.io/en/stable/installing/ .. _`pip`: https://pip.pypa.io/en/stable/installing/
.. _`wheels`: http://pythonwheels.com .. _`wheels`: http://pythonwheels.com
......
...@@ -440,7 +440,13 @@ else: ...@@ -440,7 +440,13 @@ else:
run_make = True run_make = True
if run_make and os.path.exists("Makefile"): if run_make and os.path.exists("Makefile"):
# This is effectively pointless and serves only for # The 'sdist' command renames our makefile after it
# runs so we don't try to use it from a release tarball.
# XXX: FIXME: This doesn't work correctly on win32
# because we don't rename the appveyor\\make.cmd script.
# See https://github.com/gevent/gevent/issues/757.
# NOTE: This is effectively pointless and serves only for
# documentation/metadata, because we run 'make' *before* we run # documentation/metadata, because we run 'make' *before* we run
# setup(), so installing cython happens too late. # setup(), so installing cython happens too late.
setup_requires = ['cython >= 0.23.4'] setup_requires = ['cython >= 0.23.4']
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment