Metadata-Version: 2.4
Name: panorama-elt
Version: 1.0.0
Summary: Tools to extract data, load to the datalake and transform into a source of truth for Panorama analytics.
Author-email: Aulasneo <info@aulasneo.com>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/aulasneo/panorama-elt
Keywords: openedx,analytics,etl,datalake,panorama
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: boto3
Requires-Dist: botocore
Requires-Dist: jmespath
Requires-Dist: pymongo
Requires-Dist: PyMySQL
Requires-Dist: python-dateutil
Requires-Dist: PyYAML
Requires-Dist: s3transfer
Requires-Dist: six
Requires-Dist: urllib3
Requires-Dist: click
Requires-Dist: openpyxl
Requires-Dist: cryptography
Dynamic: license-file

# panorama-elt
Tools to extract data load to the datalake and transform into a source of truth for Panorama analytics.

## Introduction

[Panorama](https://www.aulasneo.com/panorama-analytics/) is the analytics solution developed by [Aulasneo](https://www.aulasneo.com) for Open edX. 
It is a complete stack that includes data extraction, load, transformation, 
visualization and analysis. The data extracted is used to build a datalake that can easily
combine multiple LMS installations and even other sources of data.

This utility is in charge of connecting to the MySQL and MongoDB tables and extracting 
the most relevant tables. Then it uploads the data to the datalake and updates all tables and partition.

## Requirements

- Linux system
- Python 3.12
- make (`sudo apt install make`)
- virtualenv (`pip install virtualenv`)

`make install` will create a new virtual environment and install all further dependencies

listed in `requirements.txt` 
## Installation
Panorama EL can be installed in the same application host, in the databases host or in 
a bastion host. The requirement is to have connection to the databases to collect data
and to S3 that hosts the datalake.

1. Clone the repo
```shell
git clone https://github.com/aulasneo/panorama-elt
```
2. Install
```shell
make install
```
Important: do not run from inside a virtual environment
This command will:
- Create a `virtualenv` in the `venv` directory with python3 interpreter
- Install python dependencies
- Copy the settings file (if it doesn't exist) from the template

_Note_: it is possible to split the installation in multiple hosts, e.g. in one to 
access the MySQL tables and in another for the MongoDB course structures.

## Setting up the datalake
The `PanoramaDatalake` class provided is set up to connect to a AWS datalake.
However, it's methods can be overridden for other datalake technologies.

To set up your AWS datalake, you will need to:
- create or use an IAM user or role with permissions to access the S3 buckets, KMS if encrypted, Glue and Athena.
- create one S3 bucket to store the data and another as the Athena queries results location
  - we recommend to use encrypted buckets, and to have strict access policies to them
- create the Panorama database in Athena with `CREATE DATABASE panorama`
- create the Athena workgroup to keep the queries isolated from other projects
  - set the 'Query result location' to the bucket created for this workgroup

See the _first run_ section bellow to complete the datalake setup. 

### User permissions to work with AWS datalake

In order to work with a AWS datalake, you will need to create a user (e.g. _panorama-elt_)
and assign a policy (named e.g. _PanoramaELT_) with at least the following permissions.

Replace **\<region>** and **\<account id>** with proper values. 

```json
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "glue:BatchCreatePartition",
                "glue:GetDatabase",
                "athena:StartQueryExecution",
                "glue:CreateTable",
                "athena:GetQueryExecution",
                "athena:GetQueryResults",
                "glue:GetDatabases",
                "glue:GetTable",
                "glue:DeleteTable",
                "glue:GetPartitions",
                "glue:UpdateTable"
            ],
            "Resource": [
                "arn:aws:athena:<region>:<account id>:workgroup/panorama",
                "arn:aws:glue:<region>:<account id>:database/panorama",
                "arn:aws:glue:<region>:<account id>:catalog",
                "arn:aws:glue:<region>:<account id>:table/panorama/*"
            ]
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": "s3:*",
            "Resource": "*"
        }
    ]
}
```

If you have encrypted S3 buckets with KMS, you may need to add permissions to get
the KMS keys.

## Configuration

By default, the settings file is `panorama_settings.yaml`. You can override this 
setting by using the `--settings` option.

Edit the settings file and update the credentials information of the datasources.
For Open edX usage, you will have to set the following variables:

#### MySQL configuration
- mysql_username
- mysql_password
- mysql_host
- mysql_database

#### Course structures (MongoDB) configuration
- mongodb_host
- mongodb_username
- mongodb_password
- mongodb_database

#### Datalake configuration

- panorama_raw_data_bucket: destination bucket to store the datalake files
- datalake_database
- datalake_workgroup

- aws_access_key
- aws_secret_access_key
- aws_region (of the athena engine)

#### Identify the LMS 

- In the _datalake.base_partitions_ section, edit the _value_ corresponding to the _lms_ key with the url of the LMS
  (e.g.: lms.example.com)

## Running the scripts
***Before running any command, please see the next section to do the first run***

The scripts must be run from the virtual environment to run.
By default, running `panorama.py` from the command line will use the python interpreter
in the virtual environment installed `venv/bin/python`

## First run

### Create raw tables and views in the datalake catalog

Before running the commands that upload the data to the datalake, you should run the following command
to create the tables in the datalake. Failure to do that will cause errors when the upload routines tries
to update partitions in nonexistent tables.

```shell
panorama.py create-datalake-tables --all
```
By default, these tables are named `<base prefix>_raw_<table name>`

Then create the table views. Table views has exactly the same fields as the underlying raw table, 
but with numeric and date fields converted. Also strings of value _'NULL'_ are replaced with _null_ values.

```shell
panorama.py create-datalake-views --all
```

By default, these tables are named `<base prefix>_table_<table name>`

### Initial data upload
If there are tables with incremental updates enabled, you will have to make an initial run
to upload all partitions, even those that didn't change lately.
If the tables are large, this can consume lots of CPU resources and take a long time to complete.
Consider doing this out of business hours as this may impact the host performance.

_Note_: You can start doing incremental updates, and do the first run later.

To run a full update, use the `--force` option:

```shell
panorama.py extract-and-load --all --force
```

_Note_: the course structures table is not partitioned.

## Periodic updates

To run the script once an hour, add a line similar to the following one to the crontab:

```shell
0 * * * * cd panorama-elt && venv/bin/python panorama.py extract-and-load --all >> panorama.log
```

## Running in non-Open edX environments

The settings file is prepared for Open edX environments, for it has the most common
tables used and all the field information for the recommended setup.
It also includes the scripts to obtain the course structures from MongoDB,
which is specific to Open edX installation.

However, the MySQL script is suitable for any other installation using MySQL.

To configure Panorama EL for other MySQL installation follow these steps:
-Configure the mysql connection settings
- Set the `base_prefix` variable to a word that identifies your system (e.g.: wordpress, erp, forms, etc.)
- Run `panorama.py set-tables -t <table list>`, including a comma-separated list of the tables to extract. Do not leave spaces between the tables
- Run `panorama.py set-tables-fields {--all|--datasource=<datasource name>|--table=<table name>}` to retrieve each table fields from the database
- Optionally, set each table's datalake table name and/or table partitions

## Datalake directory structure

For each table (or for each field-based partition in each table when enabled), one file in csv format
will be generated and uploaded. The file will have the same name as the table, with '.csv' extension.

Each CSV file will be uploaded to the following directory structure:

```
s3://<bucket>/[<base prefix>/]<table name>/[<base partitions>/][field partitions/]<table name>.csv
```
Where:
- bucket: is the bucket name, configured in the `panorama_raw_data_bucket` setting
- base prefix: (optional) subdirectory to hold tables of a same kind of system. E.g.: openedx. 
It can receive files from multiple sources, as long as the table names are the same and share a field structure 
- table name: base location of the datalake table. All text files inside this directory must have exactly the same column structure
- base partitions: partitions common to a same installation, in Hive format. 
These are not based on fields in the data sources, but will appear as fileds in the datalake.
For multiple Open edX installations, the default is to use 'lms' as field name and the LMS_HOST as the value, which is the LMS url.
E.g.: 'lms=openedx.example.com'
- field partitions: (optional) For large tables, it's possible to split the datasource in multiple csv files.
The field will be removed from the csv file, but will appear as a partition field in the datalake.
In Open edX installations, the default setting is to partition courseware_studentmodule table by course_id.

## Advanced configuration

###Setting field partitions

To partition a table by a field, add a _partitions_ section to the table's element in _tables_, 
and list all the fields to partition under the _partition_fields_ key, as in the example:

```yaml
tables:
  - name: courseware_studentmodule
    datalake_table_name: courseware_studentmodule_raw
    partitions:
      partition_fields:
      - course_id
    fields:
      ...
```

The fields specified must be a field in the datasource table.
One different csv file will be generated for each distinct value in the specified column,
and will be placed in a subdirectory in Hive format like `<field name>=<value>`.

Be aware that this may create a huge number of subdirectories, so plan the table
fields partitions carefully.

### Incremental updates

It is possible to make incremental updates to the tables. To enable it, the table must be partitioned by field.

To enable incremental updates:
- set the field (which must be of _datetime_ format) with the timestamp information
- set the interval, using MySQL interval format. As a recommendation, use an interval
double to the query period. E.g., if you are querying the tables hourly, set a 2 hour interval

E.g.:
```yaml
tables:
  - name: courseware_studentmodule
    datalake_table_name: courseware_studentmodule_raw
    partitions:
      interval: 2 hour
      partition_fields:
      - course_id
      timestamp_field: modified
    fields:
      ...
```

####How it works?

First it will query all distinct values in the fields defined as partition fields that have records 
with timestamp in the last interval from the current time.
Then only the field based partitions detected will be updated. Note that the whole partition will be updated.

## Running inside a docker container

### Building the image

Panorama can be run from inside a docker container. There is a Dockerfile included for that purpose.
The container must bind mount the `/config` directory to hold the coniguration file.

To build the image, run:
```shell
docker build -t aulasneo/panorama-elt:$(python -c "from panorama_elt.__about__ import __version__; print(__version__)") -t aulasneo/panorama-elt:latest .
```

To bind mount the configuration directory and run the image to get a shell prompt, run:

```shell
docker run --name panorama -it -v $(pwd)/config:/config  panorama-elt:latest bash
```
Then, from inside the container's shell, you can run panorama commands indicating the location
of the settings file. E.g.:

```shell
:/# python panorama.py --settings=/config/panorama_openedx_settings.yaml test-connections
```

Note that the container must have access to the datasources and the datalake to work.

## License

This software is licenced under Apache 2.0 license. Please see LICENSE for more details.

## Contributing

Contributions are welcome! Please submit your PR and we will check it.
For questions, please send an email to <mailto:andres@aulasneo.com>.
