Installing and Testing

Most users will want to simply install the latest version, hosted on PyPI:

  1. pip install peewee

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:

  1. python setup.py build_sqlite_ext
  2. python setup.py install

Installing with git

The project is hosted at https://github.com/coleifer/peewee and can be installed using git:

  1. git clone https://github.com/coleifer/peewee.git
  2. cd peewee
  3. python setup.py install

If you would like to build the SQLite extension in a git checkout, you can run:

  1. # Build the sqlite extension and place the shared library alongside the other modules.
  2. 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.

Running tests

You can test your installation by running the test suite.

  1. python setup.py test
  3. # Or use the test runner:
  4. python runtests.py

You can test specific features or specific database drivers using the runtests.py script. By default the test suite is run using SQLite and the playhouse extension tests are not run. To view the available test runner options, use:

  1. python runtests.py --help

Optional dependencies

Note

To use Peewee, you typically won’t need anything outside the standard library, since most Python distributions are compiled with SQLite support. You can test by running import sqlite3 in the Python console. If you wish to use another database, there are many DB-API 2.0-compatible drivers out there, such as pymysql or psycopg2 for MySQL and Postgres respectively.

  • Cython: used for various speedups. Can give a big boost to certain operations, particularly if you use SQLite.
  • apsw: an optional 3rd-party SQLite binding offering greater performance and much, much saner semantics than the standard library pysqlite. Use with APSWDatabase.
  • pycrypto is used for the AESEncryptedField.
  • bcrypt module is used for the PasswordField.
  • vtfunc <https://github.com/coleifer/sqlite-vtfunc&gt; is used to provide some table-valued functions for Sqlite as part of the sqlite_udf extensions module.
  • gevent is an optional dependency for SqliteQueueDatabase (though it works with threading just fine).
  • BerkeleyDB can be compiled with a SQLite frontend, which works with Peewee. Compiling can be tricky so here are instructions.
  • Lastly, if you use the Flask or Django frameworks, there are helper extension modules available.