diff options
| author | CoprDistGit <infra@openeuler.org> | 2023-05-31 04:42:35 +0000 |
|---|---|---|
| committer | CoprDistGit <infra@openeuler.org> | 2023-05-31 04:42:35 +0000 |
| commit | 0093678fbce1a0d3706a68d525e586281c4cb6e1 (patch) | |
| tree | edb296eba25f6ba4a4d7b2937c2c3d9bbf054c31 | |
| parent | 2e47ad5a356152185bc262bfd60b2a0df97e6576 (diff) | |
automatic import of python-ecoindex-cli
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | python-ecoindex-cli.spec | 1153 | ||||
| -rw-r--r-- | sources | 1 |
3 files changed, 1155 insertions, 0 deletions
@@ -0,0 +1 @@ +/ecoindex_cli-2.20.1.tar.gz diff --git a/python-ecoindex-cli.spec b/python-ecoindex-cli.spec new file mode 100644 index 0000000..a85c3bd --- /dev/null +++ b/python-ecoindex-cli.spec @@ -0,0 +1,1153 @@ +%global _empty_manifest_terminate_build 0 +Name: python-ecoindex-cli +Version: 2.20.1 +Release: 1 +Summary: `ecoindex-cli` is a CLI tool that let you make ecoindex tests on given pages +License: MIT +URL: https://www.ecoindex.fr +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/41/f9/c2fad65e3db4381a69c03673c7fbd3338f19175b630b10288d2966588dd9/ecoindex_cli-2.20.1.tar.gz +BuildArch: noarch + +Requires: python3-typer[all] +Requires: python3-pandas +Requires: python3-Jinja2 +Requires: python3-matplotlib +Requires: python3-click-spinner +Requires: python3-pydantic +Requires: python3-Scrapy +Requires: python3-ecoindex-scraper +Requires: python3-PyYAML +Requires: python3-loguru + +%description +# Ecoindex-Cli + +[](https://github.com/cnumr/ecoindex_cli/actions/workflows/quality.yml) +[](https://badge.fury.io/py/ecoindex-cli) + +This tool provides an easy way to analyze websites with [Ecoindex](https://www.ecoindex.fr) from your local computer using multi-threading. You have the ability to: + +- Make the analysis on multiple pages +- Define multiple screen resolution +- Make a recursive analysis from a given website + +This CLI is built on top of [ecoindex-python](https://pypi.org/project/ecoindex/) with [Typer](https://typer.tiangolo.com/) + +The output is a CSV or JSON file with the results of the analysis. + +## Requirements + +- [Docker](https://docs.docker.com/get-docker/) + +## Quickstart + +The simplest way to start with ecoindex-cli is to install docker and then create an alias in your .bashrc or .zshrc file: + +```bash +alias ecoindex-cli="docker run -it --rm -v /tmp/ecoindex-cli:/tmp/ecoindex-cli vvatelot/ecoindex-cli:latest ecoindex-cli" +``` + +Then you can use the cli as if it was installed on your computer: + +```bash +ecoindex-cli --help +``` + +## Use case + +The docker image [vvatelot/ecoindex-cli](https://hub.docker.com/r/vvatelot/ecoindex-cli) is available for `linux/amd64` and `linux/arm64` platforms and provides you an easy way to use this CLI on your environment. + +The one line command to use it is: + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive --html-report +``` + +### Make a simple analysis + +You give just one web url + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr +``` + +<details><summary>Result</summary> + +```bash +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 1 url(s), do you want to process? [Y/n]: +1 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 1/1 β’ 0:00:10 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 1 β 1 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_140013/results.csv written ! +``` + +</details> + +> This makes an analysis with a screen resolution of 1920x1080px by default and with the last known version of chromedriver. You can set those settings with options: `--window-size` and `--chrome-version` +> You can add multiple urls to analyze with the option `--url`. For example: + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --url https://www.ecoindex.fr/a-propos/ +``` + +### Provide urls from a file + +You can use a file with given urls that you want to analyze: One url per line. This is helpful if you want to play the same scenario recurrently. + +```bash +ecoindex-cli analyze --urls-file input/ecoindex.csv +``` + +<details><summary>Result</summary> + +```bash +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 2 url(s), do you want to process? [Y/n]: +2 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 2/2 β’ 0:00:14 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 2 β 2 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr.csv/2023-14-04_140853/results.csv written ! +``` + +</details> + +### Make a recursive analysis + +You can make a recursive analysis of a given webiste. This means that the app will try to find out all the pages into your website and launch an analysis on all those web pages. β οΈ This can process for a very long time! **Use it at your own risks!** + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive +``` + +<details><summary>Result</summary> + +```bash +You are about to perform a recursive website scraping. This can take a long time. Are you sure to want to proceed? [Y/n]: +β²οΈ Crawling root url https://www.ecoindex.fr -> Wait a minute! +-2023-04-14 14:09:38 [scrapy.utils.log] INFO: Scrapy 2.8.0 started (bot: scrapybot) +2023-04-14 14:09:38 [scrapy.utils.log] INFO: Versions: lxml 4.9.2.0, libxml2 2.9.14, cssselect 1.2.0, parsel 1.7.0, w3lib 2.1.1, Twisted 22.10.0, Python 3.11.3 (main, Apr 5 2023, 14:15:06) [GCC 9.4.0], pyOpenSSL 23.0.0 (OpenSSL 3.0.8 7 Feb 2023), cryptography 39.0.2, Platform Linux-5.15.0-67-generic-x86_64-with-glibc2.31 +2023-04-14 14:09:38 [scrapy.crawler] INFO: Overridden settings: +{'LOG_ENABLED': False} +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 7 url(s), do you want to process? [Y/n]: +7 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 7/7 β’ 0:00:25 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 7 β 7 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_141011/results.csv written ! +``` + +</details> + +### Generate a html report + +You can generate a html report easily at the end of the analysis. You just have to add the option `--html-report`. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive --html-report +``` + +<details><summary>Result</summary> + +```bash +You are about to perform a recursive website scraping. This can take a long time. Are you sure to want to proceed? [Y/n]: +β²οΈ Crawling root url https://www.ecoindex.fr -> Wait a minute! +-2023-04-14 14:16:13 [scrapy.utils.log] INFO: Scrapy 2.8.0 started (bot: scrapybot) +2023-04-14 14:16:13 [scrapy.utils.log] INFO: Versions: lxml 4.9.2.0, libxml2 2.9.14, cssselect 1.2.0, parsel 1.7.0, w3lib 2.1.1, Twisted 22.10.0, Python 3.11.3 (main, Apr 5 2023, 14:15:06) [GCC 9.4.0], pyOpenSSL 23.0.0 (OpenSSL 3.0.8 7 Feb 2023), cryptography 39.0.2, Platform Linux-5.15.0-67-generic-x86_64-with-glibc2.31 +2023-04-14 14:16:13 [scrapy.crawler] INFO: Overridden settings: +{'LOG_ENABLED': False} +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 7 url(s), do you want to process? [Y/n]: +7 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 7/7 β’ 0:00:28 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 7 β 7 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_141645/results.csv written ! +π¦οΈ Amazing! A report has been generated to /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_141645/index.html +``` + +</details> + +> When generating a html report, the results are written in a CSV file and you can not specify the result file location. So options `--export-format` and `--output-file` are ignored. + +Here is a sample result: + + +### Other features + +#### Set the output file + +You can define the csv output file + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --output-file ~/ecoindex-results/ecoindex.csv +``` + +#### Export to JSON file + +By default, the results are exported to a CSV file. But, you can specify to export the results to a JSON file. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --export-format json +``` + +### Change wait before / after scroll + +By default, the scenario waits 3 seconds before and after scrolling to bottom of the page so that the analysis results are conform to the Ecoindex main API methodology. + +You can change this value with the option `--wait-before-scroll` and `--wait-after-scroll` to fit your needs. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --wait-before-scroll 1 --wait-after-scroll 1 +``` + +### Using a specific Chrome version + +You can use a specific Chrome version to make the analysis. This is useful if you use an old chrome version. You just have to provide the main Chrome version number. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --chrome-version 107 +``` + +Or if you do not know the Chrome version number, you can use the one line command + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --chrome-version (google-chrome --version | grep --only -P '(?<=\\s)\\d{3}') +``` + +### Using multi-threading + +You can use multi-threading to speed up the analysis when you have a lot of websites to analyze. In this case, you can define the maximum number of workers to use: + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --url https://www.greenit.fr/ --max-workers 10 +``` + +> By default, the number of maximum workers is set to CPU count. + +### Disable console interaction + +You can disable confirmations, and force the app to answer yes to all of them. It can be useful if you need to start the app from another script, or if you have no time to wait it to finish. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive --no-interaction +``` + +### Only generate a report from existing result file + +If you already performed an anlayzis and (for example), forgot to generate the html report, you do not need to re-run a full analyzis, you can simply request a report from your result file : + +```bash +ecoindex-cli report "/tmp/ecoindex-cli/output/www.ecoindex.fr/2021-05-06_191355/results.csv" "www.synchrone.fr" +``` + +<details><summary>Result</summary> + +```bash +π¦οΈ Amazing! A report has been generated to /tmp/ecoindex-cli/output/www.ecoindex.fr/2021-05-06_191355/index.html +``` + +</details> + +## Results example + +The result of the analysis is a CSV or JSON file which can be easily used for further analysis: + +### CSV example + +```csv +width,height,url,size,nodes,requests,grade,score,ges,water,date,page_type +1920,1080,https://www.ecoindex.fr,521.54,45,68,B,75.0,1.5,2.25,2022-05-03 22:28:49.280479, +1920,1080,https://www.greenit.fr,1374.641,666,167,E,32.0,2.36,3.54,2022-05-03 22:28:51.176216,website +``` + +### JSON example + +```json +[ + { + "width": 1920, + "height": 1080, + "url": "https://www.ecoindex.fr", + "size": 521.54, + "nodes": 45, + "requests": 68, + "grade": "B", + "score": 75.0, + "ges": 1.5, + "water": 2.25, + "date": "2022-05-03 22:25:01.016749", + "page_type": null + }, + { + "width": 1920, + "height": 1080, + "url": "https://www.greenit.fr", + "size": 1163.386, + "nodes": 666, + "requests": 148, + "grade": "E", + "score": 34.0, + "ges": 2.32, + "water": 3.48, + "date": "2022-05-03 22:25:04.516676", + "page_type": "website" + } +] +``` + +### Fields description + +- `width` is the screen width used for the page analysis (in pixels) +- `height` is the screen height used for the page analysis (in pixels) +- `url` is the analysed page url +- `size` is the size of the page and of the downloaded elements of the page in KB +- `nodes` is the number of the DOM elements in the page +- `requests` is the number of external requests made by the page +- `grade` is the corresponding ecoindex grade of the page (from A to G) +- `score`Β is the corresponding ecoindex score of the page (0 to 100) +- `ges` is the equivalent of greenhouse gases emission (in `gCO2e`) of the page +- `water`is the equivalent water consumption (in `cl`) of the page +- `date` is the datetime of the page analysis +- `page_type` is the type of the page, based ton the [opengraph type tag](https://ogp.me/#types) + +## Development + +### Requirements + +- Python 3.10+ +- [Poetry](https://python-poetry.org/) +- [Chrome](https://www.google.com/chrome/) (or [Chromium](https://www.chromium.org/)) +- [ChromeDriver](https://chromedriver.chromium.org/) + +### Installation + +At first, you need to install dependencies: + +```bash +git clone +cd ecoindex-cli +poetry install +``` + +You also need to install Google Chrome or Chromium and the corresponding [ChromeDriver](https://chromedriver.chromium.org/) for your OS. + +You have to download the chrome driver and put it in the project path. You can also use the `--chromedriver-path` option to specify the path to the chrome driver. + +### Usage + +```bash +poetry run ecoindex-cli --help +poetry run ecoindex-cli analyze --help +poetry run ecoindex-cli report --help +``` + +### Testing + +We use Pytest to run unit tests for this project. The test suite are in the `tests` folder. Just execute : + +```bash +poetry run pytest --cov-report term-missing:skip-covered --cov=. --cov-config=.coveragerc tests +``` + +> This runs pytest and also generate a [coverage report](https://pytest-cov.readthedocs.io/en/latest/) (terminal and html) + +## Disclaimer + +The LCA values used by [ecoindex_cli](https://github.com/cnumr/ecoindex_cli) to evaluate environmental impacts are not under free license - Β©FrΓ©dΓ©ric Bordage +Please also refer to the mentions provided in the code files for specifics on the IP regime. + +## [License](LICENSE) + +## [Contributing](CONTRIBUTING.md) + +## [Code of conduct](CODE_OF_CONDUCT.md) + + +%package -n python3-ecoindex-cli +Summary: `ecoindex-cli` is a CLI tool that let you make ecoindex tests on given pages +Provides: python-ecoindex-cli +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-ecoindex-cli +# Ecoindex-Cli + +[](https://github.com/cnumr/ecoindex_cli/actions/workflows/quality.yml) +[](https://badge.fury.io/py/ecoindex-cli) + +This tool provides an easy way to analyze websites with [Ecoindex](https://www.ecoindex.fr) from your local computer using multi-threading. You have the ability to: + +- Make the analysis on multiple pages +- Define multiple screen resolution +- Make a recursive analysis from a given website + +This CLI is built on top of [ecoindex-python](https://pypi.org/project/ecoindex/) with [Typer](https://typer.tiangolo.com/) + +The output is a CSV or JSON file with the results of the analysis. + +## Requirements + +- [Docker](https://docs.docker.com/get-docker/) + +## Quickstart + +The simplest way to start with ecoindex-cli is to install docker and then create an alias in your .bashrc or .zshrc file: + +```bash +alias ecoindex-cli="docker run -it --rm -v /tmp/ecoindex-cli:/tmp/ecoindex-cli vvatelot/ecoindex-cli:latest ecoindex-cli" +``` + +Then you can use the cli as if it was installed on your computer: + +```bash +ecoindex-cli --help +``` + +## Use case + +The docker image [vvatelot/ecoindex-cli](https://hub.docker.com/r/vvatelot/ecoindex-cli) is available for `linux/amd64` and `linux/arm64` platforms and provides you an easy way to use this CLI on your environment. + +The one line command to use it is: + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive --html-report +``` + +### Make a simple analysis + +You give just one web url + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr +``` + +<details><summary>Result</summary> + +```bash +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 1 url(s), do you want to process? [Y/n]: +1 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 1/1 β’ 0:00:10 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 1 β 1 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_140013/results.csv written ! +``` + +</details> + +> This makes an analysis with a screen resolution of 1920x1080px by default and with the last known version of chromedriver. You can set those settings with options: `--window-size` and `--chrome-version` +> You can add multiple urls to analyze with the option `--url`. For example: + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --url https://www.ecoindex.fr/a-propos/ +``` + +### Provide urls from a file + +You can use a file with given urls that you want to analyze: One url per line. This is helpful if you want to play the same scenario recurrently. + +```bash +ecoindex-cli analyze --urls-file input/ecoindex.csv +``` + +<details><summary>Result</summary> + +```bash +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 2 url(s), do you want to process? [Y/n]: +2 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 2/2 β’ 0:00:14 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 2 β 2 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr.csv/2023-14-04_140853/results.csv written ! +``` + +</details> + +### Make a recursive analysis + +You can make a recursive analysis of a given webiste. This means that the app will try to find out all the pages into your website and launch an analysis on all those web pages. β οΈ This can process for a very long time! **Use it at your own risks!** + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive +``` + +<details><summary>Result</summary> + +```bash +You are about to perform a recursive website scraping. This can take a long time. Are you sure to want to proceed? [Y/n]: +β²οΈ Crawling root url https://www.ecoindex.fr -> Wait a minute! +-2023-04-14 14:09:38 [scrapy.utils.log] INFO: Scrapy 2.8.0 started (bot: scrapybot) +2023-04-14 14:09:38 [scrapy.utils.log] INFO: Versions: lxml 4.9.2.0, libxml2 2.9.14, cssselect 1.2.0, parsel 1.7.0, w3lib 2.1.1, Twisted 22.10.0, Python 3.11.3 (main, Apr 5 2023, 14:15:06) [GCC 9.4.0], pyOpenSSL 23.0.0 (OpenSSL 3.0.8 7 Feb 2023), cryptography 39.0.2, Platform Linux-5.15.0-67-generic-x86_64-with-glibc2.31 +2023-04-14 14:09:38 [scrapy.crawler] INFO: Overridden settings: +{'LOG_ENABLED': False} +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 7 url(s), do you want to process? [Y/n]: +7 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 7/7 β’ 0:00:25 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 7 β 7 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_141011/results.csv written ! +``` + +</details> + +### Generate a html report + +You can generate a html report easily at the end of the analysis. You just have to add the option `--html-report`. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive --html-report +``` + +<details><summary>Result</summary> + +```bash +You are about to perform a recursive website scraping. This can take a long time. Are you sure to want to proceed? [Y/n]: +β²οΈ Crawling root url https://www.ecoindex.fr -> Wait a minute! +-2023-04-14 14:16:13 [scrapy.utils.log] INFO: Scrapy 2.8.0 started (bot: scrapybot) +2023-04-14 14:16:13 [scrapy.utils.log] INFO: Versions: lxml 4.9.2.0, libxml2 2.9.14, cssselect 1.2.0, parsel 1.7.0, w3lib 2.1.1, Twisted 22.10.0, Python 3.11.3 (main, Apr 5 2023, 14:15:06) [GCC 9.4.0], pyOpenSSL 23.0.0 (OpenSSL 3.0.8 7 Feb 2023), cryptography 39.0.2, Platform Linux-5.15.0-67-generic-x86_64-with-glibc2.31 +2023-04-14 14:16:13 [scrapy.crawler] INFO: Overridden settings: +{'LOG_ENABLED': False} +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 7 url(s), do you want to process? [Y/n]: +7 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 7/7 β’ 0:00:28 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 7 β 7 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_141645/results.csv written ! +π¦οΈ Amazing! A report has been generated to /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_141645/index.html +``` + +</details> + +> When generating a html report, the results are written in a CSV file and you can not specify the result file location. So options `--export-format` and `--output-file` are ignored. + +Here is a sample result: + + +### Other features + +#### Set the output file + +You can define the csv output file + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --output-file ~/ecoindex-results/ecoindex.csv +``` + +#### Export to JSON file + +By default, the results are exported to a CSV file. But, you can specify to export the results to a JSON file. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --export-format json +``` + +### Change wait before / after scroll + +By default, the scenario waits 3 seconds before and after scrolling to bottom of the page so that the analysis results are conform to the Ecoindex main API methodology. + +You can change this value with the option `--wait-before-scroll` and `--wait-after-scroll` to fit your needs. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --wait-before-scroll 1 --wait-after-scroll 1 +``` + +### Using a specific Chrome version + +You can use a specific Chrome version to make the analysis. This is useful if you use an old chrome version. You just have to provide the main Chrome version number. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --chrome-version 107 +``` + +Or if you do not know the Chrome version number, you can use the one line command + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --chrome-version (google-chrome --version | grep --only -P '(?<=\\s)\\d{3}') +``` + +### Using multi-threading + +You can use multi-threading to speed up the analysis when you have a lot of websites to analyze. In this case, you can define the maximum number of workers to use: + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --url https://www.greenit.fr/ --max-workers 10 +``` + +> By default, the number of maximum workers is set to CPU count. + +### Disable console interaction + +You can disable confirmations, and force the app to answer yes to all of them. It can be useful if you need to start the app from another script, or if you have no time to wait it to finish. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive --no-interaction +``` + +### Only generate a report from existing result file + +If you already performed an anlayzis and (for example), forgot to generate the html report, you do not need to re-run a full analyzis, you can simply request a report from your result file : + +```bash +ecoindex-cli report "/tmp/ecoindex-cli/output/www.ecoindex.fr/2021-05-06_191355/results.csv" "www.synchrone.fr" +``` + +<details><summary>Result</summary> + +```bash +π¦οΈ Amazing! A report has been generated to /tmp/ecoindex-cli/output/www.ecoindex.fr/2021-05-06_191355/index.html +``` + +</details> + +## Results example + +The result of the analysis is a CSV or JSON file which can be easily used for further analysis: + +### CSV example + +```csv +width,height,url,size,nodes,requests,grade,score,ges,water,date,page_type +1920,1080,https://www.ecoindex.fr,521.54,45,68,B,75.0,1.5,2.25,2022-05-03 22:28:49.280479, +1920,1080,https://www.greenit.fr,1374.641,666,167,E,32.0,2.36,3.54,2022-05-03 22:28:51.176216,website +``` + +### JSON example + +```json +[ + { + "width": 1920, + "height": 1080, + "url": "https://www.ecoindex.fr", + "size": 521.54, + "nodes": 45, + "requests": 68, + "grade": "B", + "score": 75.0, + "ges": 1.5, + "water": 2.25, + "date": "2022-05-03 22:25:01.016749", + "page_type": null + }, + { + "width": 1920, + "height": 1080, + "url": "https://www.greenit.fr", + "size": 1163.386, + "nodes": 666, + "requests": 148, + "grade": "E", + "score": 34.0, + "ges": 2.32, + "water": 3.48, + "date": "2022-05-03 22:25:04.516676", + "page_type": "website" + } +] +``` + +### Fields description + +- `width` is the screen width used for the page analysis (in pixels) +- `height` is the screen height used for the page analysis (in pixels) +- `url` is the analysed page url +- `size` is the size of the page and of the downloaded elements of the page in KB +- `nodes` is the number of the DOM elements in the page +- `requests` is the number of external requests made by the page +- `grade` is the corresponding ecoindex grade of the page (from A to G) +- `score`Β is the corresponding ecoindex score of the page (0 to 100) +- `ges` is the equivalent of greenhouse gases emission (in `gCO2e`) of the page +- `water`is the equivalent water consumption (in `cl`) of the page +- `date` is the datetime of the page analysis +- `page_type` is the type of the page, based ton the [opengraph type tag](https://ogp.me/#types) + +## Development + +### Requirements + +- Python 3.10+ +- [Poetry](https://python-poetry.org/) +- [Chrome](https://www.google.com/chrome/) (or [Chromium](https://www.chromium.org/)) +- [ChromeDriver](https://chromedriver.chromium.org/) + +### Installation + +At first, you need to install dependencies: + +```bash +git clone +cd ecoindex-cli +poetry install +``` + +You also need to install Google Chrome or Chromium and the corresponding [ChromeDriver](https://chromedriver.chromium.org/) for your OS. + +You have to download the chrome driver and put it in the project path. You can also use the `--chromedriver-path` option to specify the path to the chrome driver. + +### Usage + +```bash +poetry run ecoindex-cli --help +poetry run ecoindex-cli analyze --help +poetry run ecoindex-cli report --help +``` + +### Testing + +We use Pytest to run unit tests for this project. The test suite are in the `tests` folder. Just execute : + +```bash +poetry run pytest --cov-report term-missing:skip-covered --cov=. --cov-config=.coveragerc tests +``` + +> This runs pytest and also generate a [coverage report](https://pytest-cov.readthedocs.io/en/latest/) (terminal and html) + +## Disclaimer + +The LCA values used by [ecoindex_cli](https://github.com/cnumr/ecoindex_cli) to evaluate environmental impacts are not under free license - Β©FrΓ©dΓ©ric Bordage +Please also refer to the mentions provided in the code files for specifics on the IP regime. + +## [License](LICENSE) + +## [Contributing](CONTRIBUTING.md) + +## [Code of conduct](CODE_OF_CONDUCT.md) + + +%package help +Summary: Development documents and examples for ecoindex-cli +Provides: python3-ecoindex-cli-doc +%description help +# Ecoindex-Cli + +[](https://github.com/cnumr/ecoindex_cli/actions/workflows/quality.yml) +[](https://badge.fury.io/py/ecoindex-cli) + +This tool provides an easy way to analyze websites with [Ecoindex](https://www.ecoindex.fr) from your local computer using multi-threading. You have the ability to: + +- Make the analysis on multiple pages +- Define multiple screen resolution +- Make a recursive analysis from a given website + +This CLI is built on top of [ecoindex-python](https://pypi.org/project/ecoindex/) with [Typer](https://typer.tiangolo.com/) + +The output is a CSV or JSON file with the results of the analysis. + +## Requirements + +- [Docker](https://docs.docker.com/get-docker/) + +## Quickstart + +The simplest way to start with ecoindex-cli is to install docker and then create an alias in your .bashrc or .zshrc file: + +```bash +alias ecoindex-cli="docker run -it --rm -v /tmp/ecoindex-cli:/tmp/ecoindex-cli vvatelot/ecoindex-cli:latest ecoindex-cli" +``` + +Then you can use the cli as if it was installed on your computer: + +```bash +ecoindex-cli --help +``` + +## Use case + +The docker image [vvatelot/ecoindex-cli](https://hub.docker.com/r/vvatelot/ecoindex-cli) is available for `linux/amd64` and `linux/arm64` platforms and provides you an easy way to use this CLI on your environment. + +The one line command to use it is: + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive --html-report +``` + +### Make a simple analysis + +You give just one web url + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr +``` + +<details><summary>Result</summary> + +```bash +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 1 url(s), do you want to process? [Y/n]: +1 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 1/1 β’ 0:00:10 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 1 β 1 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_140013/results.csv written ! +``` + +</details> + +> This makes an analysis with a screen resolution of 1920x1080px by default and with the last known version of chromedriver. You can set those settings with options: `--window-size` and `--chrome-version` +> You can add multiple urls to analyze with the option `--url`. For example: + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --url https://www.ecoindex.fr/a-propos/ +``` + +### Provide urls from a file + +You can use a file with given urls that you want to analyze: One url per line. This is helpful if you want to play the same scenario recurrently. + +```bash +ecoindex-cli analyze --urls-file input/ecoindex.csv +``` + +<details><summary>Result</summary> + +```bash +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 2 url(s), do you want to process? [Y/n]: +2 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 2/2 β’ 0:00:14 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 2 β 2 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr.csv/2023-14-04_140853/results.csv written ! +``` + +</details> + +### Make a recursive analysis + +You can make a recursive analysis of a given webiste. This means that the app will try to find out all the pages into your website and launch an analysis on all those web pages. β οΈ This can process for a very long time! **Use it at your own risks!** + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive +``` + +<details><summary>Result</summary> + +```bash +You are about to perform a recursive website scraping. This can take a long time. Are you sure to want to proceed? [Y/n]: +β²οΈ Crawling root url https://www.ecoindex.fr -> Wait a minute! +-2023-04-14 14:09:38 [scrapy.utils.log] INFO: Scrapy 2.8.0 started (bot: scrapybot) +2023-04-14 14:09:38 [scrapy.utils.log] INFO: Versions: lxml 4.9.2.0, libxml2 2.9.14, cssselect 1.2.0, parsel 1.7.0, w3lib 2.1.1, Twisted 22.10.0, Python 3.11.3 (main, Apr 5 2023, 14:15:06) [GCC 9.4.0], pyOpenSSL 23.0.0 (OpenSSL 3.0.8 7 Feb 2023), cryptography 39.0.2, Platform Linux-5.15.0-67-generic-x86_64-with-glibc2.31 +2023-04-14 14:09:38 [scrapy.crawler] INFO: Overridden settings: +{'LOG_ENABLED': False} +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 7 url(s), do you want to process? [Y/n]: +7 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 7/7 β’ 0:00:25 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 7 β 7 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_141011/results.csv written ! +``` + +</details> + +### Generate a html report + +You can generate a html report easily at the end of the analysis. You just have to add the option `--html-report`. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive --html-report +``` + +<details><summary>Result</summary> + +```bash +You are about to perform a recursive website scraping. This can take a long time. Are you sure to want to proceed? [Y/n]: +β²οΈ Crawling root url https://www.ecoindex.fr -> Wait a minute! +-2023-04-14 14:16:13 [scrapy.utils.log] INFO: Scrapy 2.8.0 started (bot: scrapybot) +2023-04-14 14:16:13 [scrapy.utils.log] INFO: Versions: lxml 4.9.2.0, libxml2 2.9.14, cssselect 1.2.0, parsel 1.7.0, w3lib 2.1.1, Twisted 22.10.0, Python 3.11.3 (main, Apr 5 2023, 14:15:06) [GCC 9.4.0], pyOpenSSL 23.0.0 (OpenSSL 3.0.8 7 Feb 2023), cryptography 39.0.2, Platform Linux-5.15.0-67-generic-x86_64-with-glibc2.31 +2023-04-14 14:16:13 [scrapy.crawler] INFO: Overridden settings: +{'LOG_ENABLED': False} +ποΈ Urls recorded in file `/tmp/ecoindex-cli/input/www.ecoindex.fr.csv` +There are 7 url(s), do you want to process? [Y/n]: +7 urls for 1 window size with 8 maximum workers +100% ββββββββββββββββββββββββββββββββββββββββ 7/7 β’ 0:00:28 β’ 0:00:00 +ββββββββββββββββββ³ββββββββββ³βββββββββ +β Total analysis β Success β Failed β +β‘ββββββββββββββββββββββββββββββββββββ© +β 7 β 7 β 0 β +ββββββββββββββββββ΄ββββββββββ΄βββββββββ +ποΈ File /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_141645/results.csv written ! +π¦οΈ Amazing! A report has been generated to /tmp/ecoindex-cli/output/www.ecoindex.fr/2023-14-04_141645/index.html +``` + +</details> + +> When generating a html report, the results are written in a CSV file and you can not specify the result file location. So options `--export-format` and `--output-file` are ignored. + +Here is a sample result: + + +### Other features + +#### Set the output file + +You can define the csv output file + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --output-file ~/ecoindex-results/ecoindex.csv +``` + +#### Export to JSON file + +By default, the results are exported to a CSV file. But, you can specify to export the results to a JSON file. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --export-format json +``` + +### Change wait before / after scroll + +By default, the scenario waits 3 seconds before and after scrolling to bottom of the page so that the analysis results are conform to the Ecoindex main API methodology. + +You can change this value with the option `--wait-before-scroll` and `--wait-after-scroll` to fit your needs. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --wait-before-scroll 1 --wait-after-scroll 1 +``` + +### Using a specific Chrome version + +You can use a specific Chrome version to make the analysis. This is useful if you use an old chrome version. You just have to provide the main Chrome version number. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --chrome-version 107 +``` + +Or if you do not know the Chrome version number, you can use the one line command + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --chrome-version (google-chrome --version | grep --only -P '(?<=\\s)\\d{3}') +``` + +### Using multi-threading + +You can use multi-threading to speed up the analysis when you have a lot of websites to analyze. In this case, you can define the maximum number of workers to use: + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --url https://www.greenit.fr/ --max-workers 10 +``` + +> By default, the number of maximum workers is set to CPU count. + +### Disable console interaction + +You can disable confirmations, and force the app to answer yes to all of them. It can be useful if you need to start the app from another script, or if you have no time to wait it to finish. + +```bash +ecoindex-cli analyze --url https://www.ecoindex.fr --recursive --no-interaction +``` + +### Only generate a report from existing result file + +If you already performed an anlayzis and (for example), forgot to generate the html report, you do not need to re-run a full analyzis, you can simply request a report from your result file : + +```bash +ecoindex-cli report "/tmp/ecoindex-cli/output/www.ecoindex.fr/2021-05-06_191355/results.csv" "www.synchrone.fr" +``` + +<details><summary>Result</summary> + +```bash +π¦οΈ Amazing! A report has been generated to /tmp/ecoindex-cli/output/www.ecoindex.fr/2021-05-06_191355/index.html +``` + +</details> + +## Results example + +The result of the analysis is a CSV or JSON file which can be easily used for further analysis: + +### CSV example + +```csv +width,height,url,size,nodes,requests,grade,score,ges,water,date,page_type +1920,1080,https://www.ecoindex.fr,521.54,45,68,B,75.0,1.5,2.25,2022-05-03 22:28:49.280479, +1920,1080,https://www.greenit.fr,1374.641,666,167,E,32.0,2.36,3.54,2022-05-03 22:28:51.176216,website +``` + +### JSON example + +```json +[ + { + "width": 1920, + "height": 1080, + "url": "https://www.ecoindex.fr", + "size": 521.54, + "nodes": 45, + "requests": 68, + "grade": "B", + "score": 75.0, + "ges": 1.5, + "water": 2.25, + "date": "2022-05-03 22:25:01.016749", + "page_type": null + }, + { + "width": 1920, + "height": 1080, + "url": "https://www.greenit.fr", + "size": 1163.386, + "nodes": 666, + "requests": 148, + "grade": "E", + "score": 34.0, + "ges": 2.32, + "water": 3.48, + "date": "2022-05-03 22:25:04.516676", + "page_type": "website" + } +] +``` + +### Fields description + +- `width` is the screen width used for the page analysis (in pixels) +- `height` is the screen height used for the page analysis (in pixels) +- `url` is the analysed page url +- `size` is the size of the page and of the downloaded elements of the page in KB +- `nodes` is the number of the DOM elements in the page +- `requests` is the number of external requests made by the page +- `grade` is the corresponding ecoindex grade of the page (from A to G) +- `score`Β is the corresponding ecoindex score of the page (0 to 100) +- `ges` is the equivalent of greenhouse gases emission (in `gCO2e`) of the page +- `water`is the equivalent water consumption (in `cl`) of the page +- `date` is the datetime of the page analysis +- `page_type` is the type of the page, based ton the [opengraph type tag](https://ogp.me/#types) + +## Development + +### Requirements + +- Python 3.10+ +- [Poetry](https://python-poetry.org/) +- [Chrome](https://www.google.com/chrome/) (or [Chromium](https://www.chromium.org/)) +- [ChromeDriver](https://chromedriver.chromium.org/) + +### Installation + +At first, you need to install dependencies: + +```bash +git clone +cd ecoindex-cli +poetry install +``` + +You also need to install Google Chrome or Chromium and the corresponding [ChromeDriver](https://chromedriver.chromium.org/) for your OS. + +You have to download the chrome driver and put it in the project path. You can also use the `--chromedriver-path` option to specify the path to the chrome driver. + +### Usage + +```bash +poetry run ecoindex-cli --help +poetry run ecoindex-cli analyze --help +poetry run ecoindex-cli report --help +``` + +### Testing + +We use Pytest to run unit tests for this project. The test suite are in the `tests` folder. Just execute : + +```bash +poetry run pytest --cov-report term-missing:skip-covered --cov=. --cov-config=.coveragerc tests +``` + +> This runs pytest and also generate a [coverage report](https://pytest-cov.readthedocs.io/en/latest/) (terminal and html) + +## Disclaimer + +The LCA values used by [ecoindex_cli](https://github.com/cnumr/ecoindex_cli) to evaluate environmental impacts are not under free license - Β©FrΓ©dΓ©ric Bordage +Please also refer to the mentions provided in the code files for specifics on the IP regime. + +## [License](LICENSE) + +## [Contributing](CONTRIBUTING.md) + +## [Code of conduct](CODE_OF_CONDUCT.md) + + +%prep +%autosetup -n ecoindex-cli-2.20.1 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-ecoindex-cli -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 31 2023 Python_Bot <Python_Bot@openeuler.org> - 2.20.1-1 +- Package Spec generated @@ -0,0 +1 @@ +2baf4d332658a1d46a3ead2e60d1c1e3 ecoindex_cli-2.20.1.tar.gz |