Skip to content

Commit

Permalink
install docs update.
Browse files Browse the repository at this point in the history
  • Loading branch information
coleifer committed Nov 21, 2015
1 parent cc97d80 commit ca01255
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions docs/peewee/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,19 @@ Most users will want to simply install the latest version, hosted on PyPI:
pip install peewee
Peewee also comes with an optional ``playhouse.speedups`` module. If you have Cython installed, Peewee will compile the Cython extension.
Peewee comes with two C extensions that can optionally be compiled:

* Speedups, which includes miscellaneous functions re-implemented with Cython. This module will be built automatically if Cython is installed.
* Sqlite extensions, which includes Cython implementations of the SQLite date manipulation functions, the REGEXP operator, and full-text search result ranking algorithms. This module should be built using the ``build_sqlite_ext`` command.

.. note::
If you have Cython installed, then the ``speedups`` module will automatically be built. If you wish to also build the SQLite Cython extension, you must manually run:

.. code-block:: console
python setup.py build_sqlite_ext
python setup.py install
Installing with git
-------------------
Expand All @@ -23,9 +35,15 @@ using git:
cd peewee
python setup.py install
If you would like to build the SQLite extension in a git checkout, you can run:

.. code-block:: console
# Build the sqlite extension and place the shared library alongside the other modules.
python setup.py build_sqlite_ext -i
.. note::
On some systems you may need to use ``sudo python setup.py install`` to
install peewee system-wide.
On some systems you may need to use ``sudo python setup.py install`` to install peewee system-wide.

Running tests
-------------
Expand Down

0 comments on commit ca01255

Please sign in to comment.