.. role:: raw-html(raw)
   :format: html

.. _GitHub: https://github.com/jmvrbanac/specter

=======
Welcome
=======
Specter is a Python testing framework inspired from RSpec and Jasmine. The library was created out of a desire to have a relatively flexible Python testing framework that adopted a more code-centric approach to BDD.

Specter is open-source and is available on `GitHub`_. We love contributions!

.. note::

	Questions? Join us on Freenode on the #specterframework channel

Documentation
-----------------

.. toctree::
    :maxdepth: 2

    using/index
    writing_tests/index
    parallel/index
    reporting/index
    release_notes/index
    maintenance/index

Continuous Integration
-----------------------

.. only:: latex

    Travis CI builds - https://travis-ci.org/jmvrbanac/Specter

    Coveralls Coverage - https://coveralls.io/r/jmvrbanac/Specter?branch=master


.. image:: https://travis-ci.org/jmvrbanac/Specter.png?branch=master
    :target: https://travis-ci.org/jmvrbanac/Specter
    :alt: Travis CI Build status

.. image:: https://coveralls.io/repos/jmvrbanac/Specter/badge.png?branch=master
    :target: https://coveralls.io/r/jmvrbanac/Specter?branch=master
    :alt: Coveralls Coverage Status

.. image:: https://badge.fury.io/py/Specter.png
    :target: http://badge.fury.io/py/Specter
    :alt: Specter PyPi Package Page

|

Tested Python Versions
------------------------
* 3.7.x
* 3.8.x
* 3.9.x
* 3.10.x
* 3.11.x
* 3.12.x


.. Indices and tables
.. --------------------

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`