Skip to content

Commit af810c9

Browse files
Update README.md
1 parent 1accd81 commit af810c9

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Lighthouse runner for python
22

3+
## About This Repository
4+
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.
5+
6+
37
## Description
48
This library is a simple wrapper around lighthouse-cli runner that runs the audit and parses a result in friendly manner.
59

@@ -10,15 +14,15 @@ npm install -g lighthouse
1014
```
1115

1216
```bash
13-
pip install git+https://github.com/adamcupial/lighthouse-python.git#egg=lighthouse
17+
pip install lighthouse-python-plus
1418
```
1519

1620
## Usage
1721

1822
```python
1923
from lighthouse import LighthouseRunner
2024

21-
report = LighthouseRunner('https://webdesign-log.pl', form_factor='desktop', quiet=False).report
25+
report = LighthouseRunner('https://github.com/adamcupial', form_factor='desktop', quiet=False).report
2226
assert report.score['performance'] > 0.5
2327
print(report.audits['performance'].failed)
2428
```
@@ -29,9 +33,11 @@ report has 3 properties:
2933
- timings: returns dict where keys are timings and values are timedelta objects
3034
- audits: dict where keys are categories and values are objects with passed and failed lists attached
3135

36+
To see all the usage examples of this library, please check out the [demo](demo) folder.
37+
3238
## Dependencies
33-
- python 2.7+
34-
- node package lighthouse installed
39+
- python 3.6+
40+
- node package lighthouse>=10.3.0 installed
3541

3642
## Changes
3743
[You can find all changes in CHANGELOG!](CHANGELOG.md)

0 commit comments

Comments
 (0)