==============
Pytest CrateDB
==============
.. image:: https://github.com/crate/pytest-cratedb/actions/workflows/tests.yml/badge.svg
:target: https://github.com/crate/pytest-cratedb/actions/workflows/tests.yml
:alt: Build status
.. image:: https://codecov.io/gh/crate/pytest-cratedb/branch/master/graph/badge.svg
:target: https://app.codecov.io/gh/crate/pytest-cratedb
:alt: Coverage
.. image:: https://img.shields.io/pypi/v/pytest-cratedb.svg
:target: https://pypi.org/project/pytest-cratedb/
:alt: PyPI Version
.. image:: https://img.shields.io/pypi/pyversions/pytest-cratedb.svg
:target: https://pypi.org/project/pytest-cratedb/
:alt: Python Version
.. image:: https://static.pepy.tech/badge/pytest-cratedb/month
:target: https://pepy.tech/project/pytest-cratedb
:alt: PyPI Downloads
.. image:: https://img.shields.io/pypi/status/pytest-cratedb.svg
:target: https://pypi.org/project/pytest-cratedb/
:alt: Status
.. image:: https://img.shields.io/pypi/l/pytest-cratedb.svg
:target: https://pypi.org/project/pytest-cratedb/
:alt: License
|
``pytest-cratedb`` is a plugin for pytest_ for writing integration tests that
interact with CrateDB_.
The CrateDB version can be specified using the ``--crate-version`` option when
running ``pytest``. By default, the latest stable version of CrateDB is used.
Usage
=====
``pytest-cratedb`` provides a pytest ``crate`` session fixture which downloads,
starts and stops a CrateDB node.
.. code-block:: python
>>> def test_database_access(crate):
... # perform database access
... ...
Examples
========
See `tests/test_layer.py <https://github.com/crate/pytest-cratedb/blob/main/tests/test_layer.py>`_
for further examples.
Migration Notes
===============
This package, `pytest-cratedb`_ is a drop-in replacement for its predecessor
package `pytest-crate`_. It is recommended to uninstall pytest-crate
before installing pytest-cratedb in your Python environment.
Documentation and Help
======================
- `CrateDB Python Client documentation`_
- `CrateDB reference documentation`_
- `CrateDB cr8 utilities`_
- Other `support channels`_
Contributions
=============
The Pytest CrateDB Plugin is an open source project, and is `managed on
GitHub`_. We appreciate contributions of any kind.
.. _crate-python: https://pypi.org/project/crate/
.. _CrateDB: https://github.com/crate/crate
.. _CrateDB Python Client documentation: https://cratedb.com/docs/python/
.. _CrateDB cr8 utilities: https://github.com/mfussenegger/cr8/
.. _CrateDB reference documentation: https://cratedb.com/docs/reference/
.. _DB API 2.0: https://peps.python.org/pep-0249/
.. _managed on GitHub: https://github.com/crate/pytest-cratedb
.. _PyPI: https://pypi.org/
.. _pytest: https://docs.pytest.org
.. _pytest-crate: https://pypi.org/project/pytest-crate/
.. _pytest-cratedb: https://pypi.org/project/pytest-cratedb/
.. _support channels: https://cratedb.com/support/
Raw data
{
"_id": null,
"home_page": null,
"name": "pytest-cratedb",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "cratedb, integration test, pytest, software test",
"author": null,
"author_email": "Christian Haudum <developer@christianhaudum.at>, Andreas Motl <andreas.motl@crate.io>",
"download_url": "https://files.pythonhosted.org/packages/54/97/ea330397b9cb6eb206484abe4520fde30f243cb157e7665a2256b047f050/pytest_cratedb-0.4.0.tar.gz",
"platform": null,
"description": "==============\nPytest CrateDB\n==============\n\n.. image:: https://github.com/crate/pytest-cratedb/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/crate/pytest-cratedb/actions/workflows/tests.yml\n :alt: Build status\n\n.. image:: https://codecov.io/gh/crate/pytest-cratedb/branch/master/graph/badge.svg\n :target: https://app.codecov.io/gh/crate/pytest-cratedb\n :alt: Coverage\n\n.. image:: https://img.shields.io/pypi/v/pytest-cratedb.svg\n :target: https://pypi.org/project/pytest-cratedb/\n :alt: PyPI Version\n\n.. image:: https://img.shields.io/pypi/pyversions/pytest-cratedb.svg\n :target: https://pypi.org/project/pytest-cratedb/\n :alt: Python Version\n\n.. image:: https://static.pepy.tech/badge/pytest-cratedb/month\n :target: https://pepy.tech/project/pytest-cratedb\n :alt: PyPI Downloads\n\n.. image:: https://img.shields.io/pypi/status/pytest-cratedb.svg\n :target: https://pypi.org/project/pytest-cratedb/\n :alt: Status\n\n.. image:: https://img.shields.io/pypi/l/pytest-cratedb.svg\n :target: https://pypi.org/project/pytest-cratedb/\n :alt: License\n\n|\n\n``pytest-cratedb`` is a plugin for pytest_ for writing integration tests that\ninteract with CrateDB_.\n\nThe CrateDB version can be specified using the ``--crate-version`` option when\nrunning ``pytest``. By default, the latest stable version of CrateDB is used.\n\nUsage\n=====\n``pytest-cratedb`` provides a pytest ``crate`` session fixture which downloads,\nstarts and stops a CrateDB node.\n\n.. code-block:: python\n\n >>> def test_database_access(crate):\n ... # perform database access\n ... ...\n\nExamples\n========\nSee `tests/test_layer.py <https://github.com/crate/pytest-cratedb/blob/main/tests/test_layer.py>`_\nfor further examples.\n\nMigration Notes\n===============\nThis package, `pytest-cratedb`_ is a drop-in replacement for its predecessor\npackage `pytest-crate`_. It is recommended to uninstall pytest-crate\nbefore installing pytest-cratedb in your Python environment.\n\nDocumentation and Help\n======================\n- `CrateDB Python Client documentation`_\n- `CrateDB reference documentation`_\n- `CrateDB cr8 utilities`_\n- Other `support channels`_\n\nContributions\n=============\nThe Pytest CrateDB Plugin is an open source project, and is `managed on\nGitHub`_. We appreciate contributions of any kind.\n\n\n.. _crate-python: https://pypi.org/project/crate/\n.. _CrateDB: https://github.com/crate/crate\n.. _CrateDB Python Client documentation: https://cratedb.com/docs/python/\n.. _CrateDB cr8 utilities: https://github.com/mfussenegger/cr8/\n.. _CrateDB reference documentation: https://cratedb.com/docs/reference/\n.. _DB API 2.0: https://peps.python.org/pep-0249/\n.. _managed on GitHub: https://github.com/crate/pytest-cratedb\n.. _PyPI: https://pypi.org/\n.. _pytest: https://docs.pytest.org\n.. _pytest-crate: https://pypi.org/project/pytest-crate/\n.. _pytest-cratedb: https://pypi.org/project/pytest-cratedb/\n.. _support channels: https://cratedb.com/support/\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Manage CrateDB instances for integration tests",
"version": "0.4.0",
"project_urls": {
"Changelog": "https://github.com/crate/pytest-cratedb/blob/main/CHANGES.rst",
"Issues": "https://github.com/crate/pytest-cratedb/issues",
"Repository": "https://github.com/crate/pytest-cratedb"
},
"split_keywords": [
"cratedb",
" integration test",
" pytest",
" software test"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "381023afc07955e9b99b1ba454eb80c367d92817c1fe060be2121630a394cbb6",
"md5": "5837669a41f85abc9c762c7bbc3c354f",
"sha256": "7b0961072ccd1e6d37cfb469457de0b1f4d9efdc7d2e4a22e3d64ee7d280a07d"
},
"downloads": -1,
"filename": "pytest_cratedb-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5837669a41f85abc9c762c7bbc3c354f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8243,
"upload_time": "2024-10-08T00:39:56",
"upload_time_iso_8601": "2024-10-08T00:39:56.943958Z",
"url": "https://files.pythonhosted.org/packages/38/10/23afc07955e9b99b1ba454eb80c367d92817c1fe060be2121630a394cbb6/pytest_cratedb-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5497ea330397b9cb6eb206484abe4520fde30f243cb157e7665a2256b047f050",
"md5": "444f23213a0e4e20dbefa68efef8d5a0",
"sha256": "b2dcb37e529c6338cc3116bdf54162974f0dbc67fb3b4b99ead943265f4c0d57"
},
"downloads": -1,
"filename": "pytest_cratedb-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "444f23213a0e4e20dbefa68efef8d5a0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9866,
"upload_time": "2024-10-08T00:39:58",
"upload_time_iso_8601": "2024-10-08T00:39:58.979741Z",
"url": "https://files.pythonhosted.org/packages/54/97/ea330397b9cb6eb206484abe4520fde30f243cb157e7665a2256b047f050/pytest_cratedb-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-08 00:39:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "crate",
"github_project": "pytest-cratedb",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pytest-cratedb"
}
JSON
