[{"_1":2,"_155":-5,"_156":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_134":135},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":17},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":11,"_131":-5,"_132":133},"canonicalUrl","https://hub.docker.com/r/puggan/webperf/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","puggan","reponame","webperf","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2021-04-16T12:45:02.02203Z","description","Container for setting up your own webperf.se","is_private","last_updated","2021-04-16T12:56:18.547948Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",213,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Webperf Core\nMinimalistic client mainly running on PythonAnywhere.com, accessing different websites, or web-APIs, and scraping them.\n\nThe tests included in 2.x are:\n* Google Lighthouse accessibility with Axe\n* Google Lighthouse performance\n* Google Lighthouse best practice\n* Google Lighthouse progressive web apps\n* Google Lighthouse SEO\n* Testing the 404 page and status code (by default checks for Swedish text, though)\n* Validating the HTML code against W3C\n* Validating the CSS code against W3C\n* Users’ integrity test against Webbkoll, provided by Dataskydd.net\n* *Frontend quality against Yellow Lab Tools (preferably with [local instance of YLT](https://hub.docker.com/r/jguyomard/yellowlabtools))*\n* *Website performance with Sitespeed.io (requires [local instance of Sitespeed.io](https://hub.docker.com/r/sitespeedio/sitespeed.io))*\n* Carbon dioxide checked against Website Carbon Calculator API\n\n## psst. third party extensions...\n* [webperf-leaderboard](https://github.com/krompaco/webperf-leaderboard) by [Johan Kronberg](https://github.com/krompaco/)\n\n## Get started with webperf_core\nHere are some suggestions on how to get started with the tests on your own computer. Actually, it is even easier to run the tests on a cloud environment such as [PythonAnywhere - $ 5 / month](https://www.pythonanywhere.com/?affiliate_id=0007e5c6) - then the technical environment is ready to just upload the files.\n\nYou download the code itself from [GitHub - webperf_core](https://github.com/Webperf-se/webperf_core) and place it in a good location on your computer.\n### Adjust the source code\nThere are two files that you need to adjust:\n* *SAMPLE-config.py* needs to be renamed to *config.py*\nThe reason for this is because if you download a new version of the code, your settings or data should not be overwritten by accident.\n\nAnother thing you need to do is to open the *config.py* file and change one thing. The line that looks like the following is incomplete: \n*googlePageSpeedApiKey = “”* \nBetween the quotation marks, enter your Google Pagespeed API key. See the following header for how to do this.\n\n### Google Lighthouse API key\nGoogle Lighthouse API requires an API key. You can get one like this:\n1. Go to [Google Cloud Platform](https://console.cloud.google.com/apis).\n2. Search for *Pagespeed Insights API*.\n3. Click the button labelled *Manage*.\n4. Click on *Credentials* (you may need to create a project first, if you do not already have one).\n5. Click *+ Create Credentials*, then *API key*\n6. In the dialogue box the key now appears below *Your API key*, it can look like this *AIzaXyCjEXTvAq7zAU_RV_vA7slvDO9p1weRfgW*\n\nThat code is your API key, that you should put in the *config.py* file in the source code, between the quotation marks on the line where you find *googlePageSpeedApiKey*.\n\n## Running the code\nYou need to go through the following steps before you run the code:\n1. If you do not have Python 3.8 or above installed, start with [downloading Python](https://www.python.org/downloads/) (which you can ignore if you run on [PythonAnywhere](https://www.pythonanywhere.com/?affiliate_id=0007e5c6)).\n2. Open the Terminal (Macos & Linux) or Command Prompt (Windows).\n3. Navigate to where you downloaded (and unpacked) the source code. If you don’t know how to navigate in Terminal/CMD, read the [Windows guide](https://www.digitalcitizen.life/command-prompt-how-use-basic-commands) or [under Step 5 for Mac / Linux](https://computers.tutsplus.com/tutorials/navigating-the-terminal-a-gentle-introduction--mac-3855).\n4. Type the following command and hit Enter: \n*pip install -r requirements.txt* \nThen some Python extensions will be installed.\n5. Start the program with the following command and press Enter: \n*python default.py -u https://webperf.se*\n\nIf that command results in errors, you can try addressing **Python3** instead: \n*python3 default.py -u https://webperf.se*\n\nNow it will begin testing.\n\n### Options and arguments\n|Argument|What happens|\n|---|---|\n| -h/--help | Help information on how to use script |\n| -u/--url | website url to test against |\n| -t/--test | run ONE test (use ? to list available tests) |\n| -r/--review | show reviews in terminal |\n| -i/--input | input file path (.json/.sqlite) |\n| -i/--input-skip | number of items to skip |\n| -i/--input-take | number of items to take |\n| -o/--output | output file path (.json/.csv/.sql/.sqlite) |\n| -a/--addUrl | website url (required in compination with -i/--input) |\n| -d/--deleteUrl | website url (required in compination with -i/--input) |\n| -L/--language | language used for output(en = default/sv) |\n\nFor instance, if you'd like to test *https://yourwebsite.com*, get the output as a JSON-file named *my-report.json* and also see the reviews in the prompt the statement is as follows: \n```python default.py -u https://yourwebsite.com -o my-report.json -r```\n\nIf you want to test multiple URL:s and get the results as a CSV-file, then edit the file *sites.json* and run the following in your terminal to get the result in a file of your chosing, for instance *results.csv* in the application root: \n```python default.py -i sites.json -o results.csv```\n\nThe file *sites.json* already exists in the repository's root. If you'd like to check multiple websites or URL:s you've to add them inside the square brackets, separated by commas. For instance: \n```\n{ \"sites\": [\n {\n \"id\": 0,\n \"url\": \"https://webperf.se/\"\n },\n {\n \"id\": 1,\n \"url\": \"https://surfalugnt.se/\"\n }\n]\n}\n```\n\n### Are you receiving error messages? \n\nIt is often worthwhile to google the error messages you get. If you give up the search then you can always [check if someone on our Slack channel](https://webperf.se/articles/webperf-pa-slack/) have time to help you, but don’t forget to paste your error message directly in the first post. Or, if you think your error are common for more people than yourself, post an issue here at Github.\n\n### Want to add another language? \n\nThe multiple language support is built on `gettext` in Python.\n\n#### How to support new language\nYou could either follow the more technical suggestions below, or you perhaps would like an application such as [Poedit](https://poedit.net) (available on Macos, Linux and Windows).\n\nTo create a new language source file: \n```python3 -d webperf-core -o locales/webperf-core.pot default.py checks.py```\n\nCopy the file to your locale, for Swedish it would be: \n```locales/sv/LC_MESSAGES/webperf-core.pot```\n\nRename the file extension from `.pot` to `.po`\n\nAfter you have translated everything you should run the following command from the LC_MESSAGES folder: \n```python3 -o webperf-core.mo webperf-core.po```\n\nYou now have support for a new language, please send it to the official repository using a pull request :)\n\n#### How to find pygettext.py\n\nLocate your pygettext.py file: \n```locate pygettext.py```\n\nIt might be as follows: \n```/Library/Frameworks/Python.framework/Versions/3.8/share/doc/python3.8/examples/Tools/i18n/pygettext.py```\n\n#### How to find msgfmt.py\n\nLocate your msgfmt.py file: \n```locate msgfmt.py```\n\nIt might be as follows: \n```/Library/Frameworks/Python.framework/Versions/3.8/share/doc/python3.8/examples/Tools/i18n/msgfmt.py```\n\nThe command can be:\n```python3 /Library/Frameworks/Python.framework/Versions/3.8/share/doc/python3.8/examples/Tools/i18n/pygettext.py -d webperf-core -o locales/webperf-core.pot default.py```\n\n### References\n\n- https://phrase.com/blog/posts/translate-python-gnu-gettext/\n- https://docs.python.org/3/library/gettext.html\n\n## What you are allowed to do with this code / repo\nThe license used is the [MIT license](https://en.wikipedia.org/wiki/MIT_License). This means that you can do whatever you want with the source code, including using it in commercial software and contexts. However, there is no guarantee or liability for the code.\n\n## Do you want to contribute?\nYou can contribute here at Github. By checking the code, trying the documentation, suggesting new tests, among other things.\n\n## Hosting webperf_core in the cloud\n* [Get an account on PythonAnywhere and run the code in the cloud](https://www.pythonanywhere.com/?affiliate_id=0007e5c6) - through their “Tasks” function you can automatically run the code for example every day\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",357673775,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",3463678,"full_size",357230957,"id",145898236,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:4f6d8d3e2e086e1081ec0a740fb708c6a32e030eea69caf0ce87fa064e573166","features","","last_pulled","2026-09-24T03:20:49.133633727Z","last_pushed","2021-04-16T12:56:19Z","os","linux","os_features","os_version","size","variant","2021-04-16T12:56:18.202751Z","last_updater","last_updater_username","media_type","latest","repository",12339869,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":136,"_143":144,"_132":153,"_154":11},{"_36":137,"_38":138,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":139,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":140,"_75":11,"_76":142,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":141},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_145":60,"_146":-5,"_147":-5,"_148":149},"count","next","previous","results",[150],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":151,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[152],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

puggan/webperf

Tags for puggan/webperf