Quick install guide

Before you can use Server, 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 simple, minimal installation that’ll work while you walk through the introduction.

Install Python

Being a Python Web framework, Server requires Python. See What Python version can I use with Server? 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, MySQL, or Oracle. To install such a database, consult the database installation information.

Install Server

You’ve got three easy options to install Server:

  • Install an official release. This is the best approach for most users.
  • Install a version of Server provided by your operating system distribution.
  • Install the latest development version. This option is for enthusiasts who want the latest-and-greatest features and aren’t afraid of running brand new code. You might encounter new bugs in the development version, but reporting them helps the development of Server. Also, releases of third-party packages are less likely to be compatible with the development version than with the latest stable release.

Always refer to the documentation that corresponds to the version of Server 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 Server, and they likely won’t work with an official release.

Verifying

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

>>> import server
>>> print(server.get_version())
1.7.5

You may have another version of Server installed.

That’s it!

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