.. 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 or issues? Open an issue on `GitHub`_.

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

.. toctree::
    :maxdepth: 2

    using/index
    writing_tests/index
    parallel/index
    reporting/index
    api/index
    migrating/index
    troubleshooting/index
    release_notes/index
    maintenance/index

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

|

Tested Python Versions
------------------------
* 3.9.x
* 3.10.x
* 3.11.x
* 3.12.x
* 3.13.x
* 3.14.x


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

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