anfema-django-testutils


Nameanfema-django-testutils JSON
Version 0.8.0 PyPI version JSON
download
home_page
SummaryTestrunner for django which covers html report and code coverage
upload_time2023-12-18 12:53:52
maintainer
docs_urlNone
author
requires_python>=3.9
license
keywords django tests coverage testrunner
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # anfema-django-testutils
The main intention of the `anfema_django_testutils` app is to provide a Django test runner which considers
snapshot tests as well as code coverage and human-readable html test reports. Moreover, the test result
`Precondition Failure` has been added.

This package integrates [snapshottest](https://github.com/syrusakbary/snapshottest) as well as
[coverage](https://coverage.readthedocs.io/en/latest/).

## Links
- Source available at: https://github.com/anfema/anfema-django-testutils
- Documentation available at: https://anfema.github.io/anfema-django-testutils

## Prerequisites
`anfema_django_testutils` is officially supported on:
- Python >= 3.9
- Django >= 3.2

## Installation
```bash
$ pip install anfema-django-testutils
```
## Setting up


Update your Django `settings.py` to use the `anfema_django_testutils` test runner:
```python
# settings.py

INSTALLED_APPS = [
    ...
    "mathfilters",
    "anfema_django_testutils",
]

TEST_RUNNER = "anfema_django_testutils.runner.TestRunner"
```

For further information see the `anfema_django_testutils` documentation.

## Usage
For writing test cases use the `anfema_django_testutils.testcases.TestCase` rather than the `django.test.TestCase`:

```python
# app/tests.py

from anfema_django_testutils.testcases import TestCase


class CustomTest(TestCase):
    ...
```

## Create documentation
To generate the `anfema_django_testutils` documentation from the local sources, run in a terminal:

```bash
$ pip install tox
```

```bash
$ tox -e docs -- docs/build
```

## Run tests
To execute the `anfema_django_testutils` tests, run in a terminal:

```bash
$ pip install tox
```

```bash
$ tox
```

## License
Licensed under the MIT-clause license; see `LICENSE` for details.


            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "anfema-django-testutils",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "django,tests,coverage,testrunner",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/6e/2e/7aebbc64b9250dcb750ef17046ff32216cae530b5fbf3ce56ce32b41283b/anfema_django_testutils-0.8.0.tar.gz",
    "platform": null,
    "description": "# anfema-django-testutils\nThe main intention of the `anfema_django_testutils` app is to provide a Django test runner which considers\nsnapshot tests as well as code coverage and human-readable html test reports. Moreover, the test result\n`Precondition Failure` has been added.\n\nThis package integrates [snapshottest](https://github.com/syrusakbary/snapshottest) as well as\n[coverage](https://coverage.readthedocs.io/en/latest/).\n\n## Links\n- Source available at: https://github.com/anfema/anfema-django-testutils\n- Documentation available at: https://anfema.github.io/anfema-django-testutils\n\n## Prerequisites\n`anfema_django_testutils` is officially supported on:\n- Python >= 3.9\n- Django >= 3.2\n\n## Installation\n```bash\n$ pip install anfema-django-testutils\n```\n## Setting up\n\n\nUpdate your Django `settings.py` to use the `anfema_django_testutils` test runner:\n```python\n# settings.py\n\nINSTALLED_APPS = [\n    ...\n    \"mathfilters\",\n    \"anfema_django_testutils\",\n]\n\nTEST_RUNNER = \"anfema_django_testutils.runner.TestRunner\"\n```\n\nFor further information see the `anfema_django_testutils` documentation.\n\n## Usage\nFor writing test cases use the `anfema_django_testutils.testcases.TestCase` rather than the `django.test.TestCase`:\n\n```python\n# app/tests.py\n\nfrom anfema_django_testutils.testcases import TestCase\n\n\nclass CustomTest(TestCase):\n    ...\n```\n\n## Create documentation\nTo generate the `anfema_django_testutils` documentation from the local sources, run in a terminal:\n\n```bash\n$ pip install tox\n```\n\n```bash\n$ tox -e docs -- docs/build\n```\n\n## Run tests\nTo execute the `anfema_django_testutils` tests, run in a terminal:\n\n```bash\n$ pip install tox\n```\n\n```bash\n$ tox\n```\n\n## License\nLicensed under the MIT-clause license; see `LICENSE` for details.\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Testrunner for django which covers html report and code coverage",
    "version": "0.8.0",
    "project_urls": {
        "Documentation": "https://anfema.github.io/anfema-django-testutils",
        "Source": "https://github.com/anfema/anfema-django-testutils"
    },
    "split_keywords": [
        "django",
        "tests",
        "coverage",
        "testrunner"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a94761739b7c5caeaba7a8a27ab35434a9076a8b013fd93d18f8677775798807",
                "md5": "cd6bd8fbb2026428827977f1b2979593",
                "sha256": "f87c828cb49cbdfd14679fb7e1a180790745008295459a14d00a2500fc600054"
            },
            "downloads": -1,
            "filename": "anfema_django_testutils-0.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cd6bd8fbb2026428827977f1b2979593",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 26088,
            "upload_time": "2023-12-18T12:53:50",
            "upload_time_iso_8601": "2023-12-18T12:53:50.501360Z",
            "url": "https://files.pythonhosted.org/packages/a9/47/61739b7c5caeaba7a8a27ab35434a9076a8b013fd93d18f8677775798807/anfema_django_testutils-0.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6e2e7aebbc64b9250dcb750ef17046ff32216cae530b5fbf3ce56ce32b41283b",
                "md5": "a9a1e052c1f88a00bc47a020873552ce",
                "sha256": "84c4a6dc5a3440de81396d3b3f3d88ea29fb6b2f2c01c75c85c397bb41747323"
            },
            "downloads": -1,
            "filename": "anfema_django_testutils-0.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a9a1e052c1f88a00bc47a020873552ce",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 19196,
            "upload_time": "2023-12-18T12:53:52",
            "upload_time_iso_8601": "2023-12-18T12:53:52.179877Z",
            "url": "https://files.pythonhosted.org/packages/6e/2e/7aebbc64b9250dcb750ef17046ff32216cae530b5fbf3ce56ce32b41283b/anfema_django_testutils-0.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-18 12:53:52",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "anfema",
    "github_project": "anfema-django-testutils",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "anfema-django-testutils"
}
        
Elapsed time: 0.16091s