photoshoot

Name	photoshoot JSON
Version	0.2.1 JSON
	download
home_page	None
Summary	A pytest plugin for snapshot testing polars dataframes.
upload_time	2024-08-20 03:15:08
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # photoshoot

Photoshoot is a pytest plugin libary for making snapshot testing with Polars DataFrames easy.

## Installation

```bash
pip install photoshoot
```

## Usage

On the first run of this test, it will fail. Because no previous snapshot has been created.
```python
import pytest
import polars as pl

def test_dataframe(local_snapshot):
    df = pl.DataFrame({
        "a": [1, 2, 3],
        "b": [4, 5, 6],
    })
    local_snapshot(df)
```

Running the test like this, will create a snapshot of the dataframe. All future runs will compare the dataframe with the snapshot.
```bash
pytest --new-snapshot
```

Rerunning the test now will pass, as the snapshot is already created.

## Features
Currenty this library only supports Polars DataFrames, and only supports local snapshots or gcs snapshots.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "photoshoot",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/d5/53/459809cb2d7ab6f97e1fbcea1b68d8581ac1f70d447ad9aa445fab706722/photoshoot-0.2.1.tar.gz",
    "platform": null,
    "description": "# photoshoot\n\nPhotoshoot is a pytest plugin libary for making snapshot testing with Polars DataFrames easy.\n\n## Installation\n\n```bash\npip install photoshoot\n```\n\n## Usage\n\nOn the first run of this test, it will fail. Because no previous snapshot has been created.\n```python\nimport pytest\nimport polars as pl\n\ndef test_dataframe(local_snapshot):\n    df = pl.DataFrame({\n        \"a\": [1, 2, 3],\n        \"b\": [4, 5, 6],\n    })\n    local_snapshot(df)\n```\n\nRunning the test like this, will create a snapshot of the dataframe. All future runs will compare the dataframe with the snapshot.\n```bash\npytest --new-snapshot\n```\n\nRerunning the test now will pass, as the snapshot is already created.\n\n## Features\nCurrenty this library only supports Polars DataFrames, and only supports local snapshots or gcs snapshots.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A pytest plugin for snapshot testing polars dataframes.",
    "version": "0.2.1",
    "project_urls": {
        "Repository": "https://github.com/ngriffiths13/photoshoot"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1ab857313b39e4110addc183c2bde27d236175736d05da05e56235bcb8f0f8bc",
                "md5": "3dad0f78978592b08bc56cef54695156",
                "sha256": "a2ef2f269c5f8bf906baf1cdae8ae14eeae999affb48ee7ec3bda907f00344f0"
            },
            "downloads": -1,
            "filename": "photoshoot-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3dad0f78978592b08bc56cef54695156",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 6993,
            "upload_time": "2024-08-20T03:15:06",
            "upload_time_iso_8601": "2024-08-20T03:15:06.674512Z",
            "url": "https://files.pythonhosted.org/packages/1a/b8/57313b39e4110addc183c2bde27d236175736d05da05e56235bcb8f0f8bc/photoshoot-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d553459809cb2d7ab6f97e1fbcea1b68d8581ac1f70d447ad9aa445fab706722",
                "md5": "1b4dc8e44a3c20566e0455c2c427798d",
                "sha256": "0416228c77fb546ffd7bcf6afad3df87e9cbf19423a835ac35896132cf812130"
            },
            "downloads": -1,
            "filename": "photoshoot-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "1b4dc8e44a3c20566e0455c2c427798d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 7647,
            "upload_time": "2024-08-20T03:15:08",
            "upload_time_iso_8601": "2024-08-20T03:15:08.239173Z",
            "url": "https://files.pythonhosted.org/packages/d5/53/459809cb2d7ab6f97e1fbcea1b68d8581ac1f70d447ad9aa445fab706722/photoshoot-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-20 03:15:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ngriffiths13",
    "github_project": "photoshoot",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "photoshoot"
}