{"id":16768716,"url":"https://github.com/jackd248/lighthouse-garden","last_synced_at":"2025-03-16T13:43:08.478Z","repository":{"id":53621679,"uuid":"234803229","full_name":"jackd248/lighthouse-garden","owner":"jackd248","description":"Monitoring performance data for websites using the lighthouse service","archived":false,"fork":false,"pushed_at":"2024-07-16T11:19:39.000Z","size":1083,"stargazers_count":3,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-23T23:47:37.817Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Jinja","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jackd248.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-18T21:57:05.000Z","updated_at":"2024-07-16T11:19:43.000Z","dependencies_parsed_at":"2024-07-16T13:50:52.408Z","dependency_job_id":"0ea6359a-3f61-449b-9bec-ae3668086aaf","html_url":"https://github.com/jackd248/lighthouse-garden","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackd248%2Flighthouse-garden","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackd248%2Flighthouse-garden/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackd248%2Flighthouse-garden/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jackd248%2Flighthouse-garden/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jackd248","download_url":"https://codeload.github.com/jackd248/lighthouse-garden/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243878437,"owners_count":20362432,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T06:12:20.442Z","updated_at":"2025-03-16T13:43:08.458Z","avatar_url":"https://github.com/jackd248.png","language":"Jinja","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eLighthouse Garden\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\u003cimg src=\"./lighthouse_garden/templates/assets/tower.svg\" alt=\"Lighthouse\" width=\"150\"\u003e\n\u003c/p\u003e\n\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lighthouse_garden-kmi)\n![PyPI](https://img.shields.io/pypi/v/lighthouse_garden-kmi)\n[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/jackd248/lighthouse-garden/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/jackd248/lighthouse-garden/?branch=master)\n[![Build Status](https://scrutinizer-ci.com/g/jackd248/lighthouse-garden/badges/build.png?b=master)](https://scrutinizer-ci.com/g/jackd248/lighthouse-garden/build-status/master)\n\n\nAggregate a performance overview for various target pages using the [Google Lighthouse](https://github.com/GoogleChrome/lighthouse) service. \n\n![Example dashboard ](docs/images/screenshot.png)\n\n## Features\n\n- Track multiple target pages\n- Lighthouse audits for performance, accessibility, best practices and SEO\n- Average performance data\n- History performance graph with stored lighthouse reports\n- Informational badges: ![badge](https://img.shields.io/badge/performance-90-green)\n- Performance trend indicator\n\n\n## Installation\n\n### Prerequisite\n\nThe script needs [python](https://python.org/) __3.5__ or higher. It is necessary for some additional functionalities to have [pip](https://pypi.org/project/pip/) installed on your local machine. \n\n\u003ca name=\"install-pip\"\u003e\u003c/a\u003e\n### pip\nThe library can be installed from [PyPI](https://pypi.org/project/lighthouse-garden-kmi):\n```bash\n$ pip3 install lighthouse-garden-kmi\n```\n\n### Configuration\n\nThe configuration file contains important information about the script processing and target pages.\n\n```json\n{\n    \"export_path\": \"path/to/export/\",\n    \"keep_history\": 10,\n    \"targets\": [\n        {\n            \"title\": \"Google\",\n            \"identifier\": \"google\",\n            \"url\": \"https://www.google.com\"\n        }\n    ]\n}\n```\n\n## Usage\n\nRun the python script via command line.\n\n```bash\n$ python3 lighthouse_garden\n```\n\n```bash\nusage: lighthouse_garden [-h] [-v] [-c CONFIG] [--clear]\n\nMonitoring performance data by lighthouse.\n\noptional arguments:\n  -h, --help            show this help message and exit\n  -v, --verbose         Enable extended console output\n  -c CONFIG, --config CONFIG\n                        Path to config file\n  --clear               Clear all performance data and reset the application\n```\n\n![Example shell](docs/images/lighthouse-garden-example.gif)\n\n### Cronjob\n\nRegister optionally a cronjob for regularly updates\n\n```bash\n0 5 * * * python3 lighthouse_garden -c /var/www/html/config.json\n```\n\n## Test\n\nRun the script within the [DDEV](https://www.ddev.com/) container:\n\n```bash\n$ ddev start\n$ ddev ssh\n/var/www/html$ pip3 install -r requirements.txt\n/var/www/html$ python3 lighthouse_garden -c tests/config.json\n```\n\nOpen `http://lighthouse-garden.ddev.site/`\n\n## Build\n\nThe packaging process of the python module is described on [python.org](https://packaging.python.org/tutorials/packaging-projects/).\n\n## Credits\n\n- Performance analysis by [lighthouse](https://github.com/GoogleChrome/lighthouse)\n- Graph visualization by [plot.ly](https://plot.ly/javascript/)\n- Icon made by [freepik](https://www.flaticon.com/authors/freepik)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjackd248%2Flighthouse-garden","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjackd248%2Flighthouse-garden","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjackd248%2Flighthouse-garden/lists"}