pyquickhelper: various automations in python
============================================
.. image:: https://travis-ci.com/sdpython/pyquickhelper.svg?branch=master
:target: https://app.travis-ci.com/github/sdpython/pyquickhelper
:alt: Build Status Linux
.. image:: https://ci.appveyor.com/api/projects/status/t2g9olcgqgdvqq3l?svg=true
:target: https://ci.appveyor.com/project/sdpython/pyquickhelper
:alt: Build Status Windows
.. image:: https://circleci.com/gh/sdpython/pyquickhelper/tree/master.svg?style=svg
:target: https://circleci.com/gh/sdpython/pyquickhelper/tree/master
.. image:: https://dev.azure.com/xavierdupre3/pyquickhelper/_apis/build/status/sdpython.pyquickhelper
:target: https://dev.azure.com/xavierdupre3/pyquickhelper/
.. image:: https://badge.fury.io/py/pyquickhelper.svg
:target: https://pypi.org/project/pyquickhelper/
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:alt: MIT License
:target: http://opensource.org/licenses/MIT
.. image:: https://codecov.io/github/sdpython/pyquickhelper/coverage.svg?branch=master
:target: https://codecov.io/github/sdpython/pyquickhelper?branch=master
.. image:: http://img.shields.io/github/issues/sdpython/pyquickhelper.png
:alt: GitHub Issues
:target: https://github.com/sdpython/pyquickhelper/issues
.. image:: https://app.codacy.com/project/badge/Grade/9d73a6712fb24e2fa404b3e33c6201ac
:target: https://www.codacy.com/gh/sdpython/pyquickhelper/dashboard?utm_source=github.com&utm_medium=referral&utm_content=sdpython/pyquickhelper&utm_campaign=Badge_Grade
:alt: Codacy Badge
.. image:: nbcov.png
:target: http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/all_notebooks_coverage.html
:alt: Notebook Coverage
.. image:: https://pepy.tech/badge/pyquickhelper
:target: https://pypi.org/project/pyquickhelper/
:alt: Downloads
.. image:: https://img.shields.io/github/forks/sdpython/pyquickhelper.svg
:target: https://github.com/sdpython/pyquickhelper/
:alt: Forks
.. image:: https://img.shields.io/github/stars/sdpython/pyquickhelper.svg
:target: https://github.com/sdpython/pyquickhelper/
:alt: Stars
.. image:: https://img.shields.io/github/repo-size/sdpython/pyquickhelper
:target: https://github.com/sdpython/pyquickhelper/
:alt: size
**Links:** `pypi `_,
`github `_,
`documentation `_,
`wheel `_,
`travis `_,
:ref:`l-README`,
:ref:`blog `
What is it?
-----------
This module contains the automation process used by all the modules I write
including my teachings. Magic commands, `Jenkins `_ jobs,
notebook conversion into slides, scripts to build setups, documentation, unit tests.
.. toctree::
:maxdepth: 1
tutorial/index
api/index
i_nb
i_cmd
i_faq
i_galleries
Installation
------------
The module works for Python 3.5+.
The module can be migrated to Python 2.7 but this functionality
is not tested on a regular basis anymore.
::
pip install pyquickhelper
And to avoid installing the dependencies::
pip install pyquickhelper --no-deps
Others options are described at: :ref:`l-moreinstall`.
.. image:: https://mybinder.org/badge_logo.svg
:target: https://mybinder.org/v2/gh/sdpython/pyquickhelper/master
:alt: Binder
Index and License
-----------------
.. toctree::
:maxdepth: 1
license
contribute
i_indexes
HISTORY
+------------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+
| :ref:`l-modules` | :ref:`l-functions` | :ref:`l-classes` | :ref:`l-methods` | :ref:`l-staticmethods` | :ref:`l-properties` |
+------------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+
| :ref:`API ` | :ref:`l-EX2` | :ref:`search` | :ref:`l-license` | :ref:`l-changes` | :ref:`l-README` |
+------------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+
| :ref:`genindex` | :ref:`l-FAQ2` | :ref:`l-notebooks` | :ref:`l-NB2` | :ref:`l-statcode` | `Unit Test Coverage `_ |
+------------------------+---------------------+---------------------+--------------------+------------------------+------------------------------------------------+