.. image:: _static/PySpeedITMain350_220.png
   :align: center

=============
Documentation
=============

This is release |release| of a Python package named :mod:`!PySpeedIT`.

:Author: peter1000
:Github: https://github.com/peter1000


Welcome
=======
*PySpeedIT* is a collection of: Benchmark-IT, Profile-IT, Line-Memory-Profile-IT, Disassemble-IT.

It is a rewrite/continuation of a previous package called: *SpeedIT: also by peter1000*


Content Summary
===============

.. rst-class:: floater

.. seealso:: :ref:`What's new in PySpeedIT <whats-new>`


Introductory Materials
----------------------

:doc:`install`
   requirements and installations instructions


:doc:`overview`
   describes shortly the included parts


:doc:`history`
   history of current and past releases


.. _code-usage-examples:

Code & Usage Examples
=====================

:ref:`Speed-It Usage Example <speed-it-usage-example>`


For more *examples* see any files in the `PySpeedIT source`

- :samp:`{SOURCE}/Examples`

   - especially the file: **run_speed_it.py**

- :samp:`{SOURCE}/Tests`


Online Resources
================

.. rst-class:: html-plain-table

   ================ ====================================================
   Homepage:        `<https://github.com/peter1000/PySpeedIT>`_
   Online Docs:     `<http://packages.python.org/PySpeedIT>`_
   Download & PyPI: `<http://pypi.python.org/pypi/PySpeedIT>`_
   Source:          `<https://github.com/peter1000/PySpeedIT>`_
   ================ ====================================================


Projects using PySpeedIT
========================

Known `projects` which make use of: **PySpeedIT**

- `LCONF <https://github.com/peter1000/LCONF>`_
   L(ight) CONF(iguration): A light - human-friendly, simple readable data serialization format for dynamic configuration.