===================
Quick install guide
===================

Before you can use Hibee, you'll need to get it installed. We have a
:doc:`complete installation guide </topics/install>` 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, Hibee requires Python. See
:ref:`faq-python-version-support` for details. Python includes a lightweight
database called SQLite_ so you won't need to set up a database just yet.

.. _sqlite: https://www.sqlite.org/

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:

.. code-block:: pycon

    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 :ref:`database installation information <database-installation>`.

Install Hibee
==============

You've got three options to install Hibee:

* :ref:`Install an official release <installing-official-release>`. This
  is the best approach for most users.

* Install a version of Hibee :ref:`provided by your operating system
  distribution <installing-distribution-package>`.

* :ref:`Install the latest development version
  <installing-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 Hibee. Also, releases of third-party packages are
  less likely to be compatible with the development version than with the
  latest stable release.

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


Verifying
=========

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

.. parsed-literal::

    >>> import hibee
    >>> print(hibee.get_version())
    |version|

You may have another version of Hibee installed.

That's it!
==========

That's it -- you can now :doc:`move onto the tutorial </intro/tutorial01>`.
