*v0.1

Author: adamcupial

.gitignore

@@ -0,0 +1,124 @@
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+### Python Patch ###
+.venv/
+
+# End of https://www.gitignore.io/api/python

lighthouse/__init__.py

@@ -0,0 +1 @@
+from .runner import LighthouseRunner

lighthouse/report.py

@@ -0,0 +1,74 @@
+from datetime import timedelta
+from collections import namedtuple
+
+AuditResult = namedtuple('AuditResult', ['title', 'score', 'display'])
+AuditCategoryResult = namedtuple('AuditCategoryResult', ['passed', 'failed'])
+
+BASE_TIMINGS = [
+    'first-contentful-paint',
+    'speed-index',
+    'interactive',
+    'first-meaningful-paint',
+    'first-cpu-idle',
+    'estimated-input-latency',
+    'time-to-first-byte',
+]
+
+
+class LighthouseReport(object):
+    def __init__(self, data, timings=BASE_TIMINGS):
+        self.__data = data
+        self.__timings = timings
+
+    @property
+    def score(self):
+        return {
+            k: v.get('score', '0')
+            for k, v
+            in self.__data['categories'].items()
+        }
+
+    @property
+    def timings(self):
+        return {
+            k: timedelta(milliseconds=v.get('rawValue'))
+            for k, v
+            in self.__data['audits'].items()
+            if k in self.__timings
+        }
+
+    @property
+    def audits(self):
+        res = {}
+
+        for category, data in self.__data['categories'].items():
+            all_audit_refs = [
+                x.get('id')
+                for x in data['auditRefs']
+            ]
+            all_audits = {k: self.__data['audits'][k] for k in all_audit_refs}
+            sdm_to_reject = ['manual', 'notApplicable', 'informative']
+            passed_audits = [
+                AuditResult(**{
+                    'title': v['title'],
+                    'score': v['score'],
+                    'display': v.get('displayValue'),
+                })
+                for k, v in all_audits.items()
+                if v.get('score', 0) == 1 and
+                v.get('scoreDisplayMode') not in sdm_to_reject
+            ]
+
+            failed_audits = [
+                AuditResult(**{
+                    'title': v['title'],
+                    'score': v['score'],
+                    'display': v.get('displayValue'),
+                })
+                for k, v in all_audits.items()
+                if v.get('score', 0) < 1 and
+                v.get('scoreDisplayMode') not in sdm_to_reject
+            ]
+
+            res[category] = AuditCategoryResult(passed_audits, failed_audits)
+        return res

lighthouse/runner.py

@@ -0,0 +1,43 @@
+# Python Standard Library
+import json
+import os
+import subprocess
+import tempfile
+
+# Own
+from report import LighthouseReport
+
+
+class LighthouseRunner(object):
+    def __init__(self, url, form_factor='mobile', quiet=True):
+        _, self.__report_path = tempfile.mkstemp(suffix='.json')
+        self._run(url, form_factor, quiet)
+        self.report = self._get_report()
+        self._clean()
+
+    def _run(self, url, form_factor, quiet):
+        subprocess.call([
+            'lighthouse',
+            url,
+            '--quiet' if quiet else '',
+            '--chrome-flags',
+            '"--headless"',
+            '--preset',
+            'full',
+            '--emulated-form-factor',
+            form_factor,
+            '--output',
+            'json',
+            '--output-path',
+            '{0}'.format(self.__report_path),
+        ])
+
+    def _get_report(self):
+        try:
+            with open(self.__report_path, 'r') as fil:
+                return LighthouseReport(json.load(fil))
+        except ValueError:
+            pass  # @TODO
+
+    def _clean(self):
+        os.remove(self.__report_path)

setup.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+
+from setuptools import setup, find_packages
+
+setup(
+    name='lighthouse',
+    version='1.0',
+    description='Lightouse runner',
+    author='Adam Cupiał',
+    author_email='cupial.adam@gmail.com',
+    url='n/a',
+    packages=find_packages(),
+    install_requires=[]
+)