{ "info": { "author": "Xavier Dupr\u00e9", "author_email": "xavier.dupre@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", "Topic :: Software Development :: Build Tools" ], "description": "\n.. image:: https://github.com/sdpython/pyquickhelper/blob/master/_doc/sphinxdoc/source/phdoc_static/project_ico.png?raw=true\n :target: https://github.com/sdpython/pyquickhelper/\n\n.. _l-README:\n\npyquickhelper: automation of many things\n========================================\n\n.. image:: https://travis-ci.com/sdpython/pyquickhelper.svg?branch=master\n :target: https://app.travis-ci.com/github/sdpython/pyquickhelper/\n :alt: Build status\n\n.. image:: https://ci.appveyor.com/api/projects/status/t2g9olcgqgdvqq3l?svg=true\n :target: https://ci.appveyor.com/project/sdpython/pyquickhelper\n :alt: Build Status Windows\n\n.. image:: https://circleci.com/gh/sdpython/pyquickhelper/tree/master.svg?style=svg\n :target: https://circleci.com/gh/sdpython/pyquickhelper/tree/master\n\n.. image:: https://dev.azure.com/xavierdupre3/pyquickhelper/_apis/build/status/sdpython.pyquickhelper\n :target: https://dev.azure.com/xavierdupre3/pyquickhelper/\n\n.. image:: https://badge.fury.io/py/pyquickhelper.svg\n :target: https://pypi.org/project/pyquickhelper/\n\n.. image:: https://img.shields.io/badge/license-MIT-blue.svg\n :alt: MIT License\n :target: http://opensource.org/licenses/MIT\n\n.. image:: https://codecov.io/github/sdpython/pyquickhelper/coverage.svg?branch=master\n :target: https://codecov.io/github/sdpython/pyquickhelper?branch=master\n\n.. image:: http://img.shields.io/github/issues/sdpython/pyquickhelper.png\n :alt: GitHub Issues\n :target: https://github.com/sdpython/pyquickhelper/issues\n\n.. image:: https://api.codacy.com/project/badge/Grade/793ffca6089d4d02b8292a50df74a8a4\n :target: https://www.codacy.com/app/sdpython/pyquickhelper?utm_source=github.com&utm_medium=referral&utm_content=sdpython/pyquickhelper&utm_campaign=Badge_Grade\n :alt: Codacy Badge\n\n.. image:: http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/_images/nbcov.png\n :target: http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/all_notebooks_coverage.html\n :alt: Notebook Coverage\n\n.. image:: https://pepy.tech/badge/pyquickhelper/month\n :target: https://pepy.tech/project/pyquickhelper/month\n :alt: Downloads\n\n.. image:: https://img.shields.io/github/forks/sdpython/pyquickhelper.svg\n :target: https://github.com/sdpython/pyquickhelper/\n :alt: Forks\n\n.. image:: https://img.shields.io/github/stars/sdpython/pyquickhelper.svg\n :target: https://github.com/sdpython/pyquickhelper/\n :alt: Stars\n\n.. image:: https://img.shields.io/github/repo-size/sdpython/pyquickhelper\n :target: https://github.com/sdpython/pyquickhelper/\n :alt: size\n\n`pyquickhelper `_\nis used to automate the release of the documentation such as automating *Jenkins*,\nconverting notebooks into many formats, extending *Sphinx* with custom\nextensions... It assumes the project is organized on the same template\nas this one.\n\nFunctionalities\n---------------\n\n* simple forms in notebooks\n* help generation including notebook conversion\n* folder synchronization\n* logging\n* help running unit tests\n* simple server to server sphinx documentation\n* file compression, zip, gzip, 7z\n* helpers for ipython notebooks (upgrade, offline run)\n* parser to quickly add a magic command in a notebook\n* Sphinx directives to integrate a blogpost in the documentation\n* mechanism to add forms in notebooks\n\nDesign\n------\n\nThis project contains the following folders:\n\n* a source folder: *src*\n* a unit test folder: *_unittests*, go to this folder and run *run_unittests.py*\n* a folder: *_doc*, it will contain the documentation, a subfolder *_doc/sphinxdox/source/blog* contains blog post\n to communicate on the module\n* a file *setup.py* to build and to install the module, if the source were retrieve from GitHub,\n the script can also be called with the following extra options (*python setup.py