Metadata-Version: 2.1
Name: PythonPSI
Version: 1.4.4
Summary: CLI + API for Google PageSpeed Insights
Home-page: https://github.com/prakhargurunani/PyPSI
Author: Prakhar Gurunani
Author-email: prakhargurunani@gmail.com
License: UNKNOWN
Download-URL: https://github.com/prakhargurunani/PyPSI/archive/main.zip
Keywords: cli,google,python,seo,page-speed-insights,performance,google-apis
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.5, <4
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: urllib3

# PyPSI
CLI 🖥 + API for Google PageSpeed Insights

[![PythonPSI](https://img.shields.io/pypi/v/PythonPSI)](https://pypi.org/project/PythonPSI/) ![PyPI - Downloads](https://img.shields.io/pypi/dm/PythonPSI)

![PyPSI](https://raw.githubusercontent.com/prakhargurunani/PyPSI/main/PyPSI.png)

## Installation
```bash
pip install PythonPSI
```

## Usage
```bash
psi <SITE_URL> <OPTION1> <OPTION2> ...
```

Example:
```bash
psi google.com --category seo --stratergy desktop --locale en
```

### Arguments
- `URL` - Required
- `--category` - Optional, default: **performance**, description: _A Lighthouse category to run; if none are given, only Performance category will be run_
- `--locale` - Optional, default: **en**, description: _The locale used to localize formatted results_
- `--stratergy` - Optional, default: **desktop**, description: _The analysis strategy (desktop or mobile) to use, and desktop is the default_
- `--utm_campaign` - Optional, default: **None**, description: _Campaign name for analytics._
- `--utm_source` - Optional, default: **None**, description: _Campaign source for analytics._
- `--captcha_token` - Optional, default: **None**, description: _The captcha token passed when filling out a captcha._

## API Usage

```python
from PythonPSI.api import PSI

PSI('google.com', category='seo', locale='en', stratergy='desktop')
# Returns JSON output
```
- `PSI` - Required arguments: 1, Optional arguments: 6


