Reporting and data retrieval app for Open edX.

Most recent release: "0.4.dev16" on August 11, 2021

Figures is iterating through "0.4.dev" development releases on the way to an official 0.4 release.

The Figures 0.4.dev releases support Open edX Juniper, Hawthorn, and Ginkgo

• The reason for "dev" (development) instead of "rc" (release candidate) is that the 'dev' label lets us be free to make breaking changes, whereas an "rc" label is about making sure a release is stable for general community use
• Appsembler deploys "0.4.dev" releases to Tahoe production and Figures is used by our customers. This is similar to how Open edX deploys "master/main" to "edx.org" then creates named releases
• Most of the ongoing work is in the following areas
  • Improving the daily pipeline tasks for accuracy, reliability, and performance
  • Improving API performance
  • Bug fixing

Please visit Figures releases page for details on specific releases.

• Fix the comparison showing N/A when comparing to zero
  • appsembler#277
• Fix Figures devsite settings
  • appsembler#278

• FIX - Removed dependency on 'packaging.versions'
  • appsembler#272
  • NOTE: This PR updates a previous commit that required the packaging package

• Reworked SiteMonthlyMetrics registered users metric. This was causing the /figures/api/site-monthly-metrics/registered_users endpoint to timeout with a 500 error
  • appsembler#268
• Fixed Ginkgo (Django Filter 0.11.0) Backward compatibility issues
  • appsembler#266
  • appsembler#269
• UI Bug fix: Add success feedback to csv export dialog
  • appsembler#265
• Bump http-proxy from 1.18.0 to 1.18.1 in /frontend
  • appsembler#254

• Add Learners Progress Overview to main menu
  • appsembler#256
• Performance and test improvement for LearnerMetricsViewSet
  • appsembler#260
• Fix code that doesn't work on Ginkgo (Django 1.8)
  • appsembler#261

• Learner progress overview UI improvements
  • appsembler#255

• Added multi-course filtering to the learner-metrics API endpoint
  • appsembler#248
• Small cosmetic issues in new Learners Progress Overview page
  • appsembler#247

• Learner metrics Prerelease API and UI
  • appsembler#239
  • appsembler#240
• Improve logging for monthly metrics pipeline and set default to run the monthly metrics pipeline task
  • appsembler#242
• Bug fix: Site level certificate metrics
  • appsembler#244

• Adds enrollment metrics API endpoint
  • appsembler#233
• Site monthly metrics API performance improvement
  • appsembler#234
• Initial implementation of Celery support for Figures devsite
  • appsembler#215

• Fixes incorrect site monthly metrics course completion data
  • appsembler#219
• Fixes CourseDailyMetricsSerializer when average_progress is 1.00
  • appsembler#230
• Updates pipeline enrollment metrics queries to improve performance
  • appsembler#226
• Added site pipeline progress indicator to logging
  • appsembler#228
• Bump devsite Django 1.11 to version 1.11.29
  • appsembler#227
• Bump websocket-extensions from 0.1.3 to 0.1.4 in /frontend
  • appsembler#222

• Improved daily metrics pipeline performance
  • appsembler#214
• Bug fixes
  • appsembler#213

• Updated UI, MAU fix, style fixes, label changes
• Added site monthly metrics scheduled tasks to fill last month's MAU
• Added Django Debug Toolbar to devsite

• Performance improvement to "Site Monthly Metrics" active users endpoint

• Updated UI to improve performance and usability
• Added "Course Monthly Metrics" set of API endpoints

• Updated UI to address performance issues
• Added missing organizations to devsite settings INSTALLED_APPS

Client (UI and API) facing updates

• Site Monthly Metrics pipeline and new API endpoints
• Added Course MAU metrics API endpoint and pipeline
• Added user email address to general user data
• Bug fix - URL pattern fix for figures/

Developer facing updates

• Updated Django micro version to Figures devsite
• Added missing .env file for Makefile support
• Added Pylint to testing
• Refactored permissions module

• Hawthorn support since release 0.3.0
• This release includes bug fixes, UI improvements, and backport support for Ginkgo
• Includes a standalone development mode. See the developer quickstart guide

Figures is a reporting and data retrieval app. It plugs into the edx-platform LMS app server. Its goal is to provide site-wide and cross-course analytics that compliment Open edX's traditional course-centric analytics.

To evolve Figures to meet community needs, we are keeping in mind as principles the following features, which Jill Vogel outlined in her lightweight analytics post on ed Xchange:

• Real time (or near real time) updates
• Lightweight deployment
• Flexible reporting
• Simpler contributions

Please refer to the Figures design document for more details on goals and architecture.

For all Open edX releases:

• Python (2.7)

For Hawthorn:

• Django (1.11)

For Ginkgo:

• Django (1.8)

NOTICE: Installation instructions are out of date and backlogged for update

Go here for instructions to install and run Figures in devstack.

Go here for instructions to install Figures in production.

The Figures user interface is a JavaScript Single Page Application (SPA) built with React and uses the create-react-app build scaffolding generator.

The Figures back-end is a reusable Django app. It contains a set of REST API endpoints that serve a dual purpose of providing data to the front-end and to remote clients.

TODO: Improve the testing instructions

The unit tests should be able to run on any OS that supports Python 2.7.x

Clone the repo:

[email protected]:appsembler/figures.git

Go to the project directory:

cd figures

Create a virtualenv for Python 2.7.x.

Install required Python packages:

pip install -r devsite/requirements.txt

From the figures repository root directory:

py.test

If all goes well, the Figures unit tests will all complete succesfully

• Open edX "Hawthorn" will provide a plug-in architecture. This will hopefully simplify Figures installation even more
• Downloadable report files
• Plugin architecture to extend Figures for custom data sources

TODO: Add details here or separate CONTRIBUTING file to the root of the repo

If you find bugs or run into issues, please submit an issue ticket to the Figures issue tracker on Github.

Please do not report security issues in public. Please email [email protected].