easecloud-mageperf 0.1.0__tar.gz

easecloud_mageperf-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest tests/ -v

easecloud_mageperf-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,62 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest tests/ -v
+
+  build:
+    name: Build
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build
+        run: pip install build
+
+      - name: Build wheel and sdist
+        run: python -m build
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for trusted publishing
+    steps:
+      - name: Download dist artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

easecloud_mageperf-0.1.0/.gitignore

@@ -0,0 +1,36 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.egg-info/
+dist/
+build/
+.eggs/
+.venv/
+venv/
+*.egg
+
+# Pytest
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Node / Next.js
+ui/node_modules/
+ui/.next/
+ui/out/
+ui/tsconfig.tsbuildinfo
+ui/next-env.d.ts
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Editor
+.vscode/
+.idea/
+*.swp
+
+# Env
+.env
+.env.local

easecloud_mageperf-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing to mageperf
+
+Thank you for your interest in contributing! This guide covers everything you need to get started.
+
+---
+
+## Ways to contribute
+
+- **Bug reports** — open an issue with steps to reproduce
+- **Feature requests** — open an issue describing the use case
+- **Pull requests** — fixes, new checks, UI improvements, docs
+
+---
+
+## Getting started
+
+### Prerequisites
+
+- Python 3.11+
+- Node.js 18+ (only if editing the UI)
+
+### Setup
+
+```bash
+git clone https://github.com/easecloudio/mageperf.git
+cd mageperf
+pip install -e ".[dev]"
+```
+
+If `[dev]` extras aren't available yet, install dev deps directly:
+
+```bash
+pip install pytest pytest-asyncio pytest-mock
+```
+
+### Run tests
+
+```bash
+pytest tests/ -v
+```
+
+All 20 tests must pass before submitting a PR.
+
+---
+
+## Project structure
+
+```
+mageperf/core/      Analysis engine — add new checks here
+mageperf/cli.py     CLI commands — add new commands here
+mageperf/storage/   Report persistence
+mageperf/server/    Local HTTP server
+tests/              pytest suite — add tests for every change
+ui/src/             Next.js frontend source
+```
+
+---
+
+## Adding a new check
+
+1. Add your logic to `mageperf/core/magento_checker.py` or `performance_checker.py`
+2. Return a `CheckResult` dataclass with `category`, `score`, `details`, `recommendations`
+3. Wire it into `analysis_orchestrator.py`
+4. Add at least one test in `tests/`
+
+---
+
+## Pull request guidelines
+
+- Keep PRs focused — one feature or fix per PR
+- All tests must pass (`pytest tests/ -v`)
+- Follow existing code style (no formatter enforced, just be consistent)
+- Update `README.md` if you add a new command or config key
+
+---
+
+## Reporting a vulnerability
+
+Please do **not** open a public issue for security vulnerabilities.  
+Email [security@easecloud.io](mailto:security@easecloud.io) instead.
+
+---
+
+## License
+
+By contributing you agree your code will be released under the [MIT License](LICENSE).

easecloud_mageperf-0.1.0/Dockerfile

@@ -0,0 +1,24 @@
+FROM python:3.11-slim
+
+LABEL org.opencontainers.image.title="mageperf"
+LABEL org.opencontainers.image.description="EaseCloud Magento Performance Analyzer"
+LABEL org.opencontainers.image.source="https://github.com/easecloud/mageperf"
+LABEL org.opencontainers.image.vendor="EaseCloud"
+LABEL org.opencontainers.image.licenses="MIT"
+
+WORKDIR /app
+
+# Copy package files
+COPY pyproject.toml README.md ./
+COPY mageperf/ ./mageperf/
+
+# Install dependencies
+RUN pip install --no-cache-dir .
+
+# Create config directory
+RUN mkdir -p /root/.easecloud/mageperf/reports
+
+EXPOSE 4780
+
+ENTRYPOINT ["mageperf"]
+CMD ["--help"]

easecloud_mageperf-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 EaseCloud (https://easecloud.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

easecloud_mageperf-0.1.0/PKG-INFO

@@ -0,0 +1,229 @@
+Metadata-Version: 2.4
+Name: easecloud-mageperf
+Version: 0.1.0
+Summary: Free, open-source Magento performance analysis CLI by EaseCloud
+Project-URL: Homepage, https://easecloud.io
+Project-URL: Repository, https://github.com/easecloudio/mageperf
+Project-URL: Bug Tracker, https://github.com/easecloudio/mageperf/issues
+Author-email: EaseCloud <support@easecloud.io>
+License: MIT
+License-File: LICENSE
+Keywords: cli,easecloud,magento,performance
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.11
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: dnspython>=2.4.0
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: httpx>=0.28.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.0.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# mageperf
+
+**Free, open-source Magento performance analysis CLI by [EaseCloud](https://www.easecloud.io)**
+
+`mageperf` scans any Magento 2 store from your terminal — no account, no cloud, no data leaving your machine. It checks performance, security posture, and configuration best practices, then saves reports locally and optionally opens a browser UI.
+
+---
+
+## Features
+
+- **Magento detection** — fingerprints Magento version, edition, and deployment mode
+- **Performance analysis** — Core Web Vitals via Google PageSpeed Insights API (optional)
+- **Security checks** — exposed admin paths, debug mode, insecure headers
+- **Configuration checks** — caching, JS/CSS merging, CDN, production mode
+- **Local reports** — stored in `~/.easecloud/mageperf/reports/` as JSON
+- **Browser UI** — rich report viewer served locally on port 4780
+- **JSON output** — pipe results into scripts or AI agents
+
+---
+
+## Installation
+
+### pip (recommended)
+
+```bash
+pip install easecloud-mageperf
+```
+
+### npm / npx
+
+```bash
+npx @easecloud/mageperf analyze https://your-store.com
+# or install globally
+npm install -g @easecloud/mageperf
+```
+
+### Docker
+
+```bash
+docker run --rm easecloud/mageperf analyze https://your-store.com
+```
+
+### One-line install script
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/easecloudio/mageperf/main/install.sh | bash
+```
+
+---
+
+## Quick start
+
+```bash
+# Analyze a store
+mageperf analyze https://your-store.com
+
+# Analyze and open the browser UI when done
+mageperf analyze https://your-store.com --open
+
+# JSON output (pipe into jq, scripts, AI agents)
+mageperf analyze https://your-store.com --format json | jq .overall_score
+
+# List saved reports
+mageperf list
+
+# Open the local report UI
+mageperf serve
+```
+
+---
+
+## Commands
+
+| Command                             | Description                      |
+| ----------------------------------- | -------------------------------- |
+| `mageperf analyze <url>`            | Run a full analysis              |
+| `mageperf list`                     | List saved reports               |
+| `mageperf open <id>`                | Open a report in the browser UI  |
+| `mageperf serve`                    | Start the local report UI server |
+| `mageperf clean`                    | Delete all saved reports         |
+| `mageperf config set <key> <value>` | Set a config value               |
+| `mageperf config get <key>`         | Get a config value               |
+
+### `analyze` options
+
+| Flag              | Default   | Description                               |
+| ----------------- | --------- | ----------------------------------------- |
+| `--format`        | `summary` | Output format: `summary`, `json`, `table` |
+| `--output <file>` | —         | Write JSON report to a file               |
+| `--open`          | off       | Open browser UI after analysis            |
+| `--no-pagespeed`  | off       | Skip Google PageSpeed API calls           |
+
+---
+
+## Configuration
+
+Config is stored in `~/.easecloud/mageperf/config.json`.
+
+```bash
+# Set your Google PageSpeed API key (optional, improves accuracy)
+mageperf config set pagespeed-api-key YOUR_KEY
+
+# Change the local UI port (default: 4780)
+mageperf config set server-port 4780
+```
+
+Get a free PageSpeed API key at [Google Cloud Console](https://console.cloud.google.com/).  
+Without a key, `mageperf` falls back to direct HTTP analysis.
+
+---
+
+## How it works
+
+Analysis runs in four layers:
+
+1. **Magento detection** — headers, HTML patterns, JS indicators, known paths
+2. **Performance** — PageSpeed Insights API (optional) or direct HTTP timing
+3. **Security** — admin URL exposure, debug headers, error reporting
+4. **Configuration** — caching strategy, JS/CSS bundling, deployment mode
+
+All checks use only publicly available data. No credentials, no admin access required.
+
+---
+
+## Output example
+
+```
+Overall Score: 74/100
+
+  Performance   82  ████████░░
+  Security      61  ██████░░░░
+  Config        79  ███████░░░
+
+2 critical issues found. Run with --open to view full report.
+Report saved: ~/.easecloud/mageperf/reports/abc123.json
+```
+
+> **Found critical issues?** EaseCloud provides [Magento performance optimization consulting](https://www.easecloud.io/magento-performance-optimization) — Core Web Vitals, caching strategy, infrastructure tuning, and more.
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/easecloudio/mageperf.git
+cd mageperf
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Build the UI (requires Node 18+)
+cd ui && npm install && npm run build
+```
+
+### Project structure
+
+```
+mageperf/           Python package
+  cli.py            Typer CLI entry point
+  config.py         Config management (~/.easecloud/mageperf/)
+  core/             Analysis engine
+    magento_checker.py
+    performance_checker.py
+    analysis_orchestrator.py
+    scoring_service.py
+  storage/          Local JSON report store
+  server/           stdlib HTTP server + pre-built UI
+    static/         Pre-built Next.js UI
+tests/              pytest test suite (20 tests)
+ui/                 Next.js 15 UI source (TypeScript)
+Dockerfile          Docker image build
+install.sh          Universal install script
+package.json        npm wrapper (@easecloud/mageperf)
+```
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## Work with EaseCloud
+
+`mageperf` finds the problems. Need help fixing them?
+
+We offer end-to-end [Magento performance optimization](https://www.easecloud.io/magento-performance-optimization) — from diagnosis to implementation across caching, Core Web Vitals, infrastructure, and deployment.
+
+Contact: [support@easecloud.io](mailto:support@easecloud.io) · [easecloud.io](https://easecloud.io)
+
+---
+
+## License
+
+MIT © [EaseCloud](https://easecloud.io)

easecloud_mageperf-0.1.0/README.md

@@ -0,0 +1,197 @@
+# mageperf
+
+**Free, open-source Magento performance analysis CLI by [EaseCloud](https://www.easecloud.io)**
+
+`mageperf` scans any Magento 2 store from your terminal — no account, no cloud, no data leaving your machine. It checks performance, security posture, and configuration best practices, then saves reports locally and optionally opens a browser UI.
+
+---
+
+## Features
+
+- **Magento detection** — fingerprints Magento version, edition, and deployment mode
+- **Performance analysis** — Core Web Vitals via Google PageSpeed Insights API (optional)
+- **Security checks** — exposed admin paths, debug mode, insecure headers
+- **Configuration checks** — caching, JS/CSS merging, CDN, production mode
+- **Local reports** — stored in `~/.easecloud/mageperf/reports/` as JSON
+- **Browser UI** — rich report viewer served locally on port 4780
+- **JSON output** — pipe results into scripts or AI agents
+
+---
+
+## Installation
+
+### pip (recommended)
+
+```bash
+pip install easecloud-mageperf
+```
+
+### npm / npx
+
+```bash
+npx @easecloud/mageperf analyze https://your-store.com
+# or install globally
+npm install -g @easecloud/mageperf
+```
+
+### Docker
+
+```bash
+docker run --rm easecloud/mageperf analyze https://your-store.com
+```
+
+### One-line install script
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/easecloudio/mageperf/main/install.sh | bash
+```
+
+---
+
+## Quick start
+
+```bash
+# Analyze a store
+mageperf analyze https://your-store.com
+
+# Analyze and open the browser UI when done
+mageperf analyze https://your-store.com --open
+
+# JSON output (pipe into jq, scripts, AI agents)
+mageperf analyze https://your-store.com --format json | jq .overall_score
+
+# List saved reports
+mageperf list
+
+# Open the local report UI
+mageperf serve
+```
+
+---
+
+## Commands
+
+| Command                             | Description                      |
+| ----------------------------------- | -------------------------------- |
+| `mageperf analyze <url>`            | Run a full analysis              |
+| `mageperf list`                     | List saved reports               |
+| `mageperf open <id>`                | Open a report in the browser UI  |
+| `mageperf serve`                    | Start the local report UI server |
+| `mageperf clean`                    | Delete all saved reports         |
+| `mageperf config set <key> <value>` | Set a config value               |
+| `mageperf config get <key>`         | Get a config value               |
+
+### `analyze` options
+
+| Flag              | Default   | Description                               |
+| ----------------- | --------- | ----------------------------------------- |
+| `--format`        | `summary` | Output format: `summary`, `json`, `table` |
+| `--output <file>` | —         | Write JSON report to a file               |
+| `--open`          | off       | Open browser UI after analysis            |
+| `--no-pagespeed`  | off       | Skip Google PageSpeed API calls           |
+
+---
+
+## Configuration
+
+Config is stored in `~/.easecloud/mageperf/config.json`.
+
+```bash
+# Set your Google PageSpeed API key (optional, improves accuracy)
+mageperf config set pagespeed-api-key YOUR_KEY
+
+# Change the local UI port (default: 4780)
+mageperf config set server-port 4780
+```
+
+Get a free PageSpeed API key at [Google Cloud Console](https://console.cloud.google.com/).  
+Without a key, `mageperf` falls back to direct HTTP analysis.
+
+---
+
+## How it works
+
+Analysis runs in four layers:
+
+1. **Magento detection** — headers, HTML patterns, JS indicators, known paths
+2. **Performance** — PageSpeed Insights API (optional) or direct HTTP timing
+3. **Security** — admin URL exposure, debug headers, error reporting
+4. **Configuration** — caching strategy, JS/CSS bundling, deployment mode
+
+All checks use only publicly available data. No credentials, no admin access required.
+
+---
+
+## Output example
+
+```
+Overall Score: 74/100
+
+  Performance   82  ████████░░
+  Security      61  ██████░░░░
+  Config        79  ███████░░░
+
+2 critical issues found. Run with --open to view full report.
+Report saved: ~/.easecloud/mageperf/reports/abc123.json
+```
+
+> **Found critical issues?** EaseCloud provides [Magento performance optimization consulting](https://www.easecloud.io/magento-performance-optimization) — Core Web Vitals, caching strategy, infrastructure tuning, and more.
+
+---
+
+## Development
+
+```bash
+git clone https://github.com/easecloudio/mageperf.git
+cd mageperf
+pip install -e ".[dev]"
+
+# Run tests
+pytest tests/ -v
+
+# Build the UI (requires Node 18+)
+cd ui && npm install && npm run build
+```
+
+### Project structure
+
+```
+mageperf/           Python package
+  cli.py            Typer CLI entry point
+  config.py         Config management (~/.easecloud/mageperf/)
+  core/             Analysis engine
+    magento_checker.py
+    performance_checker.py
+    analysis_orchestrator.py
+    scoring_service.py
+  storage/          Local JSON report store
+  server/           stdlib HTTP server + pre-built UI
+    static/         Pre-built Next.js UI
+tests/              pytest test suite (20 tests)
+ui/                 Next.js 15 UI source (TypeScript)
+Dockerfile          Docker image build
+install.sh          Universal install script
+package.json        npm wrapper (@easecloud/mageperf)
+```
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+---
+
+## Work with EaseCloud
+
+`mageperf` finds the problems. Need help fixing them?
+
+We offer end-to-end [Magento performance optimization](https://www.easecloud.io/magento-performance-optimization) — from diagnosis to implementation across caching, Core Web Vitals, infrastructure, and deployment.
+
+Contact: [support@easecloud.io](mailto:support@easecloud.io) · [easecloud.io](https://easecloud.io)
+
+---
+
+## License
+
+MIT © [EaseCloud](https://easecloud.io)