tdd-guard-pytest


Nametdd-guard-pytest JSON
Version 0.1.2 PyPI version JSON
download
home_pageNone
SummaryPytest plugin for TDD Guard - enforces Test-Driven Development principles
upload_time2025-07-28 08:33:43
maintainerNone
docs_urlNone
authorNizar Selander, Durafen
requires_python>=3.8
licenseNone
keywords tdd test-driven-development testing pytest claude
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # TDD Guard Pytest Reporter

Pytest plugin that captures test results for TDD Guard validation.

## Requirements

- Python 3.8+
- pytest 6.0+
- [TDD Guard](https://github.com/nizos/tdd-guard) installed globally

## Installation

```bash
pip install tdd-guard-pytest
```

The plugin activates automatically when installed.

## Configuration

### Project Root Configuration

Set `tdd_guard_project_root` to your project root using any ONE of these methods:

**Option 1: pyproject.toml**

```toml
[tool.pytest.ini_options]
tdd_guard_project_root = "/absolute/path/to/project/root"
```

**Option 2: pytest.ini**

```ini
[pytest]
tdd_guard_project_root = /absolute/path/to/project/root
```

**Option 3: setup.cfg**

```ini
[tool:pytest]
tdd_guard_project_root = /absolute/path/to/project/root
```

### Configuration Rules

- Path must be absolute
- Current directory must be within the configured project root
- Falls back to current directory if configuration is invalid

## Development

When developing the pytest reporter, you need to configure the project root to ensure test results are saved to the correct location:

1. Copy the example configuration:

   ```bash
   cp pytest.ini.example pytest.ini
   ```

2. Edit `pytest.ini` and set the absolute path to your TDD Guard project root:
   ```ini
   [pytest]
   tdd_guard_project_root = /absolute/path/to/tdd-guard
   ```

**Note:** `pytest.ini` is gitignored to avoid committing machine-specific paths.

## More Information

- Test results are saved to `.claude/tdd-guard/data/test.json`
- See [TDD Guard documentation](https://github.com/nizos/tdd-guard) for complete setup

## License

MIT

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tdd-guard-pytest",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "tdd, test-driven-development, testing, pytest, claude",
    "author": "Nizar Selander, Durafen",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/e4/82/204f333a4d9005d2b8bdd39108bd40542a342f7296451d332a48ccb32a5c/tdd_guard_pytest-0.1.2.tar.gz",
    "platform": null,
    "description": "# TDD Guard Pytest Reporter\n\nPytest plugin that captures test results for TDD Guard validation.\n\n## Requirements\n\n- Python 3.8+\n- pytest 6.0+\n- [TDD Guard](https://github.com/nizos/tdd-guard) installed globally\n\n## Installation\n\n```bash\npip install tdd-guard-pytest\n```\n\nThe plugin activates automatically when installed.\n\n## Configuration\n\n### Project Root Configuration\n\nSet `tdd_guard_project_root` to your project root using any ONE of these methods:\n\n**Option 1: pyproject.toml**\n\n```toml\n[tool.pytest.ini_options]\ntdd_guard_project_root = \"/absolute/path/to/project/root\"\n```\n\n**Option 2: pytest.ini**\n\n```ini\n[pytest]\ntdd_guard_project_root = /absolute/path/to/project/root\n```\n\n**Option 3: setup.cfg**\n\n```ini\n[tool:pytest]\ntdd_guard_project_root = /absolute/path/to/project/root\n```\n\n### Configuration Rules\n\n- Path must be absolute\n- Current directory must be within the configured project root\n- Falls back to current directory if configuration is invalid\n\n## Development\n\nWhen developing the pytest reporter, you need to configure the project root to ensure test results are saved to the correct location:\n\n1. Copy the example configuration:\n\n   ```bash\n   cp pytest.ini.example pytest.ini\n   ```\n\n2. Edit `pytest.ini` and set the absolute path to your TDD Guard project root:\n   ```ini\n   [pytest]\n   tdd_guard_project_root = /absolute/path/to/tdd-guard\n   ```\n\n**Note:** `pytest.ini` is gitignored to avoid committing machine-specific paths.\n\n## More Information\n\n- Test results are saved to `.claude/tdd-guard/data/test.json`\n- See [TDD Guard documentation](https://github.com/nizos/tdd-guard) for complete setup\n\n## License\n\nMIT\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Pytest plugin for TDD Guard - enforces Test-Driven Development principles",
    "version": "0.1.2",
    "project_urls": {
        "Bug Tracker": "https://github.com/nizos/tdd-guard/issues",
        "Documentation": "https://github.com/nizos/tdd-guard/tree/main/reporters/pytest",
        "Homepage": "https://github.com/nizos/tdd-guard",
        "Repository": "https://github.com/nizos/tdd-guard"
    },
    "split_keywords": [
        "tdd",
        " test-driven-development",
        " testing",
        " pytest",
        " claude"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c4c769e1e53cfc6e06776cfe633d806ac78f643fcf8474ec1bdbf6e374aeb214",
                "md5": "5207fc87ec87f211f99d2cdf0010a6fd",
                "sha256": "4ca9333315f859b841461c03760ff8fe5d3525ab2389230233e7ad594f90117e"
            },
            "downloads": -1,
            "filename": "tdd_guard_pytest-0.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5207fc87ec87f211f99d2cdf0010a6fd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4427,
            "upload_time": "2025-07-28T08:33:42",
            "upload_time_iso_8601": "2025-07-28T08:33:42.617948Z",
            "url": "https://files.pythonhosted.org/packages/c4/c7/69e1e53cfc6e06776cfe633d806ac78f643fcf8474ec1bdbf6e374aeb214/tdd_guard_pytest-0.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e482204f333a4d9005d2b8bdd39108bd40542a342f7296451d332a48ccb32a5c",
                "md5": "ab060d36ddbe48489b46594ab383af4a",
                "sha256": "5fafd89e0dac6140d7db46865d12c09075d0ed211b6aac7c300393994582be00"
            },
            "downloads": -1,
            "filename": "tdd_guard_pytest-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "ab060d36ddbe48489b46594ab383af4a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8332,
            "upload_time": "2025-07-28T08:33:43",
            "upload_time_iso_8601": "2025-07-28T08:33:43.630353Z",
            "url": "https://files.pythonhosted.org/packages/e4/82/204f333a4d9005d2b8bdd39108bd40542a342f7296451d332a48ccb32a5c/tdd_guard_pytest-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-28 08:33:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "nizos",
    "github_project": "tdd-guard",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "tdd-guard-pytest"
}
        
Elapsed time: 4.95785s