Skip to content

Commit

Permalink
MAINT: rename package to scipy-weave
Browse files Browse the repository at this point in the history
  • Loading branch information
rgommers committed Nov 30, 2022
1 parent 46dcfb4 commit 62c6148
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 16 deletions.
16 changes: 8 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
Weave provides tools for including C/C++ code within Python code. Inlining
C/C++ code within Python generally results in speedups of 1.5x to 30x over
algorithms written in pure Python.
``scipy-weave`` provides tools for including C/C++ code within Python code.
Inlining C/C++ code within Python generally results in speedups of 1.5x to 30x
over algorithms written in pure Python.

Weave is the stand-alone version of the deprecated Scipy submodule
``scipy-weave`` is the stand-alone version of the removed SciPy submodule
``scipy.weave``. It is Python 2.x only, and is provided for users that need
new versions of Scipy (from which the ``weave`` submodule may be removed) but
versions of SciPy from which the ``weave`` submodule has been removed but
have existing code that still depends on ``scipy.weave``. For new code, users
are recommended to use Cython.

To install Weave, use of pip is recommended::
To install ``scipy-weave``, use of pip is recommended::

pip install weave
pip install scipy-weave

To run the tests::
Note that the import name for ``scipy-weave`` is ``weave``. To run the tests::

python2 -c "import weave; weave.test('full')"

24 changes: 16 additions & 8 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
#!/usr/bin/env python
"""Weave: a C++ compiler for Python.
"""scipy-weave: a C++ compiler for Python 2.
Weave provides tools for including C/C++ code within Python code. Inlining
C/C++ code within Python generally results in speedups of 1.5x to 30x over
algorithms written in pure Python.
scipy-weave provides tools for including C/C++ code within Python code.
Inlining C/C++ code within Python generally results in speedups of 1.5x to 30x
over algorithms written in pure Python.
Weave is the stand-alone version of the deprecated Scipy submodule
``scipy-weave`` is the stand-alone version of the removed SciPy submodule
``scipy.weave``. It is Python 2.x only, and is provided for users that need
new versions of Scipy (from which the ``weave`` submodule may be removed) but
versions of SciPy from which the ``weave`` submodule has been removed but
have existing code that still depends on ``scipy.weave``. For new code, users
are recommended to use Cython.
To install ``scipy-weave``, use of pip is recommended::
pip install scipy-weave
Note that the import name for ``scipy-weave`` is ``weave``. To run the tests::
python2 -c "import weave; weave.test('full')"
"""

DOCLINES = __doc__.split("\n")
Expand Down Expand Up @@ -164,8 +172,8 @@ def setup_package():
cmdclass = {}

metadata = dict(
name = 'weave',
maintainer = "Weave developers",
name = 'scipy-weave',
maintainer = "scipy-weave developers",
maintainer_email = "scipy-dev@scipy.org",
description = DOCLINES[0],
long_description = "\n".join(DOCLINES[2:]),
Expand Down

0 comments on commit 62c6148

Please sign in to comment.