Basic Installation

This section covers some key steps to get you started.

Prerequisites

There are some software components that need to be installed prior to starting.

1. pattoo requires the installation of a MySQL or MariaDB database. Make sure this software is installed beforehand.
2. pattoo only runs on Python 3.6 or higher

Let’s install the software.

Installation

Follow these steps.

1. Install git on your system.

2. Select and create the parent directory in which you want to install pattoo.

   $ mkdir -p /installation/parent/directory
   $ cd /installation/parent/directory
   

3. Clone the repository to the parent directory using the git clone command. You can also choose to downloading and unzip the file in the parent directory. The repository can be found at: https://github.com/PalisadoesFoundation/pattoo

   $ cd /installation/parent/directory
   $ git clone https://github.com/PalisadoesFoundation/pattoo.git
   

4. Enter the /installation/parent/directory/pattoo directory with the pattoo files.

5. Install the required packages using the pip_requirements document in the pattoo root directory

   $ pip3 install -r pip_requirements.txt
   

6. Create the MySQL or MariaDB database for pattoo with the correct authentication parameters provided in the Configuration Guide In this example adjust the name of your database and the password accordingly.

   $ sudo mysql
   

   CREATE DATABASE pattoo;
   GRANT ALL PRIVILEGES ON pattoo.* TO pattoo@"localhost" IDENTIFIED BY 'PATTOO_PASSWORD';
   FLUSH PRIVILEGES;
   exit;
   

7. Use the Configuration Guide to create a working configuration.

8. Run the installation script

   $ sudo setup/install.py install all
   

9. View additional installation options Installation Modes

10. Configure the required cron jobs. Periodic Jobs