Quick install guide

Before you can use GingerDJ, you’ll need to get it installed. We have a complete installation guide that covers all the possibilities; this guide will guide you to a minimal installation that’ll work while you walk through the introduction.

Install Python

Being a Python web framework, GingerDJ requires Python. See What Python version can I use with GingerDJ? for details. Python includes a lightweight database called SQLite so you won’t need to set up a database just yet.

Get the latest version of Python at https://www.python.org/downloads/ or with your operating system’s package manager.

You can verify that Python is installed by typing python from your shell; you should see something like:

Python 3.x.y
[GCC 4.x] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>

Set up a database

This step is only necessary if you’d like to work with a “large” database engine like PostgreSQL, MariaDB, MySQL, or Oracle. To install such a database, consult the database installation information.

Install GingerDJ

You’ve got three options to install GingerDJ:

Always refer to the documentation that corresponds to the version of GingerDJ you’re using!

If you do either of the first two steps, keep an eye out for parts of the documentation marked new in development version. That phrase flags features that are only available in development versions of GingerDJ, and they likely won’t work with an official release.

Verifying

To verify that GingerDJ can be seen by Python, type python from your shell. Then at the Python prompt, try to import GingerDJ:

>>> import gingerdj
>>> print(gingerdj.get_version())
5.1

You may have another version of GingerDJ installed.

That’s it!

That’s it – you can now move onto the tutorial.