Merge pull request #7 from sh-alireza/master

some bugs fixed, ready for pypi

Author: adamcupial

Diff for: CHANGELOG.md

@@ -4,8 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
--
+## [1.2.0] - 2023-06-29
+## changed
+- All modules receive timings as input
+- The raw output can be saved in a preferred format, either json, html, or both
+- The demo has been updated
+
+## [1.1.0] - 2023-06-29
+## changed
+- Old syntax fixed
+- Made compatible to run in docker
+- Demo Added
+
+## Adam Cupal
 ## [1.0.2] - 2019-02-22
 ### Changed
 - added option to runner to pass custom parameters
@@ -18,7 +29,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [1.0.0] - 2019-02-05
 ### Added
 - Base runner
-
-[Unreleased]: https://github.com/adamcupial/lighthouse-python/compare/1.0.1...HEAD
-[1.0.1]: https://github.com/adamcupial/lighthouse-python/compare/1.0.0...1.0.1
-[1.0.2]: https://github.com/adamcupial/lighthouse-python/compare/1.0.1...1.0.2

Diff for: LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Adam Cupiał
+Copyright (c) 2023 Adam Cupiał & alireza sharifi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Diff for: README.md

@@ -1,5 +1,9 @@
 # Lighthouse runner for python
 
+## About This Repository
+This repository is based on the original work of [Adam Cupiał](https://github.com/adamcupial) and was forked from his [lighthouse-python](https://github.com/adamcupial/lighthouse-python) repository. While the original repository had not been updated in five years, I found it to be a valuable resource and decided to update it (I have made some changes, fixed some bugs) and turn it into a package for PyPI. I want to acknowledge the original author for creating the foundation of this project and making it available to the community.
+
+
 ## Description
 This library is a simple wrapper around lighthouse-cli runner that runs the audit and parses a result in friendly manner.
 
@@ -10,17 +14,21 @@ npm install -g lighthouse
 ```
 
 ```bash
-pip install git+https://github.com/adamcupial/lighthouse-python.git#egg=lighthouse
+pip install lighthouse-python-plus
 ```
 
 ## Usage
 
 ```python
 from lighthouse import LighthouseRunner
 
-report = LighthouseRunner('https://webdesign-log.pl', form_factor='desktop', quiet=False).report
+TIMINGS = [
+    'speed-index'
+]
+
+report = LighthouseRunner('https://github.com/adamcupial', form_factor='desktop', quiet=False, timings=TIMINGS).report
 assert report.score['performance'] > 0.5
-print(report.audits['performance'].failed)
+print(report.audits(0.5)['performance'].failed)
 ```
 
 report has 3 properties:
@@ -29,9 +37,11 @@ report has 3 properties:
 - timings: returns dict where keys are timings and values are timedelta objects
 - audits: dict where keys are categories and values are objects with passed and failed lists attached
 
+To see all the usage examples of this library, please check out the [demo](demo) folder.
+
 ## Dependencies
- - python 2.7+
- - node package lighthouse installed
+ - python 3.6+
+ - node package lighthouse>=10.3.0 installed
 
 ## Changes
 [You can find all changes in CHANGELOG!](CHANGELOG.md)

Diff for: demo/demo_batch_runner.py

@@ -0,0 +1,29 @@
+from lighthouse import BatchRunner
+
+
+urls = ["https://amazon.com","https://alibaba.com"]
+form_factors = ["mobile","desktop"]
+
+TIMINGS = [
+    'first-contentful-paint',
+    'speed-index',
+    'interactive',
+]
+
+# settings are as the same as the pagespeed.web.dev
+additional_settings = [
+"--throttling.cpuSlowdownMultiplier=4",
+"--throttling.connectionType=4g",
+"--throttling.downloadThroughputKbps=1638.4",
+"--throttling.rttMs=150",
+"--screenEmulation.disabled=false",
+"--screenEmulation.width=412",
+"--screenEmulation.height=823",
+"--screenEmulation.deviceScaleFactor=1.75",
+"--axe.enable=true",
+"--axe.version=4.7.0",
+]
+
+batch_runner = BatchRunner(urls,form_factors,quiet=False,additional_settings=additional_settings,repeats=2,timings=TIMINGS)
+
+print(batch_runner.reports)

Diff for: demo/demo_repeat_runner.py

@@ -0,0 +1,29 @@
+from lighthouse import  LighthouseRepeatRunner
+
+
+url="https://github.com"
+
+TIMINGS = [
+    'first-contentful-paint',
+    'speed-index',
+    'interactive',
+]
+
+# settings are as the same as the pagespeed.web.dev
+additional_settings = [
+"--throttling.cpuSlowdownMultiplier=4",
+"--throttling.connectionType=4g",
+"--throttling.downloadThroughputKbps=1638.4",
+"--throttling.rttMs=150",
+"--screenEmulation.disabled=false",
+"--screenEmulation.width=412",
+"--screenEmulation.height=823",
+"--screenEmulation.deviceScaleFactor=1.75",
+"--axe.enable=true",
+"--axe.version=4.7.0",
+]
+
+repeat_runner = LighthouseRepeatRunner(url,"desktop",quiet=False,additional_settings=additional_settings,repeats=2,timings=TIMINGS)
+
+print(repeat_runner.report.score)
+print(repeat_runner.report.timings)

Diff for: demo/demo_runner.py

@@ -0,0 +1,31 @@
+from lighthouse import LighthouseRunner
+
+
+url="https://github.com"
+
+TIMINGS = [
+    'first-contentful-paint',
+    'speed-index',
+    'interactive',
+]
+
+# settings are as the same as the pagespeed.web.dev
+additional_settings = [
+"--throttling.cpuSlowdownMultiplier=4",
+"--throttling.connectionType=4g",
+"--throttling.downloadThroughputKbps=1638.4",
+"--throttling.rttMs=150",
+"--screenEmulation.disabled=false",
+"--screenEmulation.width=412",
+"--screenEmulation.height=823",
+"--screenEmulation.deviceScaleFactor=1.75",
+"--axe.enable=true",
+"--axe.version=4.7.0",
+]
+
+runner = LighthouseRunner(url,"mobile",quiet=False,additional_settings=additional_settings,
+                          timings=TIMINGS,output_type='both',output_dir='./outputs')
+
+print(runner.report.score)
+print(runner.report.timings)
+print(runner.report.audits(0.86)['performance'].passed)

Diff for: lighthouse/__init__.py

@@ -1,2 +1 @@
-from .runner import LighthouseRunner, LighthouseRepeatRunner
-from .batch import BatchRunner
+from .runner import LighthouseRunner, LighthouseRepeatRunner, BatchRunner

Diff for: lighthouse/batch.py

@@ -1,46 +1,36 @@
-# this python file uses the following encoding utf-8
-
-# Python Standard Library
+# Standard library modules
 from collections import namedtuple
 from datetime import timedelta
+from typing import Dict, List
 
 
-AuditResult = namedtuple('AuditResult', ['title', 'score', 'display'])
+AuditResult = namedtuple('AuditResult', ['id','title', 'score', 'display','numval','numunit'])
 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',
-]
-"""list(str) default list of timings"""
-
-
-class LighthouseReport(object):
+class LighthouseReport:
     """
-    Lighthouse report abstract
+    Represents a Lighthouse report.
 
-    Should provide more pleasant report then the lighthouse JSON.
+    Provides a more user-friendly interface to the Lighthouse JSON report.
     """
 
-    def __init__(self, data, timings=BASE_TIMINGS):
+    def __init__(self, data: Dict, timings: List[str] = []):
         """
         Args:
-            data (dict): JSON loaded lighthouse report
-            timings (list(str), optional): list of timings
-                to gather
+            data (dict): JSON loaded Lighthouse report
+            
+            timings (list(str), optional): List of timings to gather
+                from Lighthouse report. Defaults to an empty list.
         """
 
         self.__data = data
         self.__timings = timings
 
     @property
-    def score(self):
-        """ Dictionary of lighthouse's category name: score (0 to 1) """
+    def score(self) -> Dict[str, float]:
+        """
+        Dictionary of Lighthouse category names and their corresponding scores (0 to 1).
+        """
 
         return {
             k: v.get('score', 0)
@@ -49,24 +39,29 @@ def score(self):
         }
 
     @property
-    def timings(self):
-        """ Dictionary of lighthouse's timings names: timedelta times """
+    def timings(self) -> Dict[str, timedelta]:
+        """
+        Dictionary of Lighthouse timing names and their corresponding times as timedeltas.
+        """
 
         return {
-            k: timedelta(milliseconds=v.get('rawValue'))
+            k: timedelta(milliseconds=v.get('numericValue')) 
             for k, v
             in self.__data['audits'].items()
             if k in self.__timings
         }
 
-    @property
-    def audits(self):
+    def audits(self, score_thresh: float = 1) -> Dict[str, AuditCategoryResult]:
         """
-        Dictionary of audits as category name: object with passed/failed keys
-            with lists attached.
+        Returns a dictionary of Lighthouse audits, grouped by category, with passed/failed
+        keys and lists of passed/failed audits attached.
+
+        Args:
+            score_thresh (float, optional): The minimum score required for an audit to be considered
+                passed. Defaults to 1 (all audits must pass).
         """
-        res = {}
 
+        res = {}
         for category, data in self.__data['categories'].items():
             all_audit_refs = [
                 x.get('id')
@@ -76,23 +71,30 @@ def audits(self):
             sdm_to_reject = ['manual', 'notApplicable', 'informative']
             passed_audits = [
                 AuditResult(**{
+                    'id': v['id'],
                     'title': v['title'],
                     'score': v['score'],
                     'display': v.get('displayValue'),
+                    'numval': v.get('numericValue'),
+                    'numunit': v.get('numericUnit'),
                 })
                 for k, v in all_audits.items()
-                if v.get('score', 0) == 1 and
+                if v.get('score',0) is not None and 
+                v.get('score', 0) >= score_thresh and
                 v.get('scoreDisplayMode') not in sdm_to_reject
             ]
 
             failed_audits = [
                 AuditResult(**{
+                    'id': v['id'],
                     'title': v['title'],
                     'score': v['score'],
                     'display': v.get('displayValue'),
+                    'numval': v.get('numericValue'),
+                    'numunit': v.get('numericUnit'),
                 })
                 for k, v in all_audits.items()
-                if v.get('score', 0) < 1 and
+                if (v.get('score',0) is None or v.get('score', 0) < score_thresh) and
                 v.get('scoreDisplayMode') not in sdm_to_reject
             ]