browsercontrol 0.1.1__tar.gz → 0.1.3__tar.gz

{browsercontrol-0.1.1 → browsercontrol-0.1.3}/.gitignore

@@ -6,13 +6,8 @@
 # Python
 */__pycache__/*
 *.py[cod]
-*$py.class
-*.so
-.Python
-*.egg-info/
 dist/
-build/
+.pytest_cache/
 
 # Virtual environments
 .venv/
-

browsercontrol-0.1.3/.pre-commit-config.yaml

@@ -0,0 +1,56 @@
+repos:
+  # Ruff - Fast Python linter and formatter
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
+    hooks:
+      # Run the linter
+      - id: ruff
+        args: [--fix]
+      # Run the formatter
+      - id: ruff-format
+
+  # General file checks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-json
+      - id: check-added-large-files
+        args: [--maxkb=1000]
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: mixed-line-ending
+        args: [--fix=lf]
+
+  # Markdown formatting
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        types_or: [markdown, yaml, json]
+        exclude: ^(uv\.lock|\.vscode/)
+
+  # Python security checks
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.8.0
+    hooks:
+      - id: bandit
+        args: [-c, pyproject.toml]
+        additional_dependencies: ["bandit[toml]"]
+        exclude: ^tests/
+
+# CI configuration
+ci:
+  autofix_commit_msg: |
+    [pre-commit.ci] auto fixes from pre-commit hooks
+
+    for more information, see https://pre-commit.ci
+  autofix_prs: true
+  autoupdate_branch: ""
+  autoupdate_commit_msg: "[pre-commit.ci] pre-commit autoupdate"
+  autoupdate_schedule: weekly
+  skip: []
+  submodules: false

browsercontrol-0.1.3/CODE_QUALITY.md

@@ -0,0 +1,81 @@
+# Code Formatting and Quality
+
+This project uses automated code formatting and linting tools to maintain code quality.
+
+## Tools
+
+- **[Ruff](https://github.com/astral-sh/ruff)** - Fast Python linter and formatter
+- **[Pre-commit](https://pre-commit.com/)** - Git hooks for automated checks
+- **[Prettier](https://prettier.io/)** - Markdown/YAML/JSON formatting
+- **[Bandit](https://bandit.readthedocs.io/)** - Security vulnerability scanner
+
+## Setup
+
+The tools are already configured. To install the pre-commit hooks:
+
+```bash
+uv sync
+uv run pre-commit install
+```
+
+## Usage
+
+### Manual Formatting
+
+```bash
+# Check for linting issues
+uv run ruff check .
+
+# Auto-fix linting issues
+uv run ruff check . --fix
+
+# Format code
+uv run ruff format .
+
+# Run all pre-commit hooks manually
+uv run pre-commit run --all-files
+```
+
+### Automatic Formatting
+
+Pre-commit hooks run automatically on `git commit`. They will:
+
+1. Run ruff linter and formatter
+2. Trim trailing whitespace
+3. Fix end-of-file issues
+4. Format markdown/YAML/JSON with prettier
+5. Check for security issues with bandit
+
+If any hook fails, the commit will be aborted and files will be auto-fixed. Review the changes and commit again.
+
+## Configuration
+
+### Ruff
+
+Configuration in `pyproject.toml`:
+
+- **Line length**: 100 characters
+- **Target Python**: 3.11+
+- **Enabled rules**: pycodestyle, pyflakes, isort, pep8-naming, pyupgrade, bugbear, comprehensions, simplify, type-checking, Ruff-specific
+- **Ignored rules**: E501 (line too long), B008 (function call in defaults), N805 (first arg naming), SIM117 (nested with), B904 (exception chaining)
+
+### Pre-commit
+
+Configuration in `.pre-commit-config.yaml`:
+
+- Ruff linter and formatter
+- General file checks (trailing whitespace, EOF, YAML/TOML/JSON validation, large files, merge conflicts)
+- Prettier for markdown formatting
+- Bandit for security checks (excludes tests, allows subprocess for Playwright)
+
+## Bypassing Hooks
+
+If you need to bypass pre-commit hooks (not recommended):
+
+```bash
+git commit --no-verify
+```
+
+## CI Integration
+
+Pre-commit.ci is configured to run automatically on pull requests and can auto-fix issues.

{browsercontrol-0.1.1 → browsercontrol-0.1.3}/CONTRIBUTING.md

@@ -23,7 +23,11 @@ We love your input! We want to make contributing to BrowserControl as easy and t
    ```bash
    uv run playwright install chromium
    ```
-5. **Run the server in dev mode**:
+5. **Install pre-commit hooks**:
+   ```bash
+   uv run pre-commit install
+   ```
+6. **Run the server in dev mode**:
    ```bash
    uv run fastmcp dev browsercontrol/server.py
    ```
@@ -33,11 +37,13 @@ We love your input! We want to make contributing to BrowserControl as easy and t
 We use [uv](https://github.com/astral-sh/uv) for dependency management and packaging. It's fast and reliable.
 
 ### Project Structure
+
 - `browsercontrol/server.py`: Main MCP server definition
 - `browsercontrol/browser.py`: Core logic (Playwright + Set of Marks)
 - `browsercontrol/tools/`: Tool implementations split by category
 
 ### Making Changes
+
 1. Create a branch for your feature: `git checkout -b feature/amazing-feature`
 2. Implement your changes
 3. Run tests (see below)
@@ -48,17 +54,33 @@ We use [uv](https://github.com/astral-sh/uv) for dependency management and packa
 
 ## 🧪 Testing
 
-We use `pytest`. Please ensure all tests pass before submitting a PR.
+We use `pytest` for testing and `ruff` for code quality. Please ensure all checks pass before submitting a PR.
 
 ```bash
 # Run all tests
 uv run pytest
 
+# Run tests with coverage
+uv run pytest --cov=browsercontrol
+
+# Check code formatting and linting
+uv run ruff check .
+uv run ruff format .
+
+# Run all pre-commit hooks
+uv run pre-commit run --all-files
+```
+
+See [CODE_QUALITY.md](CODE_QUALITY.md) for more details on code formatting and quality tools.
+
 # Run specific test file
+
 uv run pytest tests/test_navigation.py
+
 ```
 
 If you add a new tool or feature, please add a corresponding test case covering:
+
 - Happy path (it works)
 - Error handling (it fails gracefully)
 
@@ -82,3 +104,4 @@ Bugs are tracked as GitHub issues. When filing an issue, please explain the prob
 ## 📄 License
 
 By contributing, you agree that your contributions will be licensed under its MIT License.
+```