pytest-cram 0.2.2
Run cram tests with pytest.
License: MIT license

.. image:: https://img.shields.io/pypi/v/pytest-cram.svg
  :target: https://pypi.python.org/pypi/pytest-cram
  :alt: Latest PyPI version

.. image:: https://img.shields.io/pypi/dm/pytest-cram.svg
  :target: https://pypi.python.org/pypi/pytest-cram
  :alt: Number of PyPI downloads

.. image:: https://img.shields.io/travis/tbekolay/pytest-cram/master.svg
  :target: https://travis-ci.org/tbekolay/pytest-cram
  :alt: Travis-CI build status

.. image:: https://ci.appveyor.com/api/projects/status/dxu61i3rbn847uje/branch/master?svg=true
  :target: https://ci.appveyor.com/project/tbekolay/pytest-cram
  :alt: AppVeyor build status

.. image:: https://img.shields.io/coveralls/tbekolay/pytest-cram/master.svg
  :target: https://coveralls.io/r/tbekolay/pytest-cram?branch=master
  :alt: Test coverage


****************************************
pytest-cram: Run cram tests with py.test
****************************************

cram_ tests command line applications.
pytest_ tests Python applications.
pytest-cram tests Python command line applications
by letting you write your Python API tests with pytest,
and your command line tests in cram.
Best of both worlds!

.. _cram: https://bitheap.org/cram/
.. _pytest: http://pytest.org/latest/


Installation
============

To install and use pytest-cram, do ::

  pip install pytest-cram

pytest-cram works on Python 2.7 and 3.3+
and with cram_ versions 0.7 and up.

Usage
=====

Once installed, all ``.t`` files will be collected
and run with cram, so installation should be all that is needed.

If you wish to disable cram tests for an invocation of
pytest, do ::

  py.test --nocram

To override the shell used by cram, do ::

  py.test --shell="C:\git\bash.exe"

or set the ``CRAMSHELL`` environment variable ::

  CRAMSHELL=/bin/bash py.test

If you wish to disable specific cram tests,
list them in a ``.ini`` file ::

  [pytest]
  cramignore = file1.t
      pattern*.t

..
   Documentation & Examples
   ========================

   Documentation can be found at ReadTheDocs

***************
Release History
***************

.. Changelog entries should follow this format:

   version (release date)
   ======================

   **section**

   - One-line description of change (link to Github issue/PR)

.. Changes should be organized in one of several sections:

   - Added
   - Changed
   - Deprecated
   - Removed
   - Fixed

0.2.2 (2020-08-08)
==================

**Fixed**

- Updated for recent pytest changes. (`#13`_)

.. _#13: https://github.com/tbekolay/pytest-cram/pull/13

0.2.1 (2020-05-10)
==================

**Fixed**

- Updated to use more recent pytest features. (`#11`_, `#12`_)

.. _#11: https://github.com/tbekolay/pytest-cram/pull/11
.. _#12: https://github.com/tbekolay/pytest-cram/pull/12

0.2.0 (2018-02-06)
==================

**Fixed**

- Fixed tests to work with ``pytest>=3.3``. Pytest added progress indicators
  to test output in version 3.3, which the tests were not expecting.

0.1.1 (2016-03-07)
==================

**Added**

- Added the ``--shell`` command line option and now checks the ``CRAMSHELL``
  environment variable to override the default ``/bin/sh`` shell. (`#3`_)

  Thanks to `Florian Rathgeber <https://github.com/kynan>`_ for the contribution!

**Changed**

- Depend explicitly on ``cram>=0.7``. If you would like support for earlier
  versions of cram, please
  `file an issue <https://github.com/tbekolay/pytest-cram/issues/new>`_.

.. _#3: https://github.com/tbekolay/pytest-cram/pull/3

0.1.0 (2016-02-28)
==================

Initial release of ``pytest-cram``! Supports Python 2.7+ and 3.3+.