# -*- coding: utf-8 -*-
"""
Module *papierstat*.
Look for insights for machine learned models.
:githublink:`%|py|7`
"""
__version__ = "0.2.433"
__author__ = "Xavier Dupré"
__github__ = "https://github.com/sdpython/papierstat"
__url__ = "http://www.xavierdupre.fr/app/papierstat/helpsphinx/index.html"
__license__ = "MIT License"
__blog__ = """
<?xml version="1.0" encoding="UTF-8"?>
<opml version="1.0">
<head>
<title>blog</title>
</head>
<body>
<outline text="papierstat"
title="papierstat"
type="rss"
xmlUrl="http://www.xavierdupre.fr/app/papierstat/helpsphinx/_downloads/rss.xml"
htmlUrl="http://www.xavierdupre.fr/app/papierstat/helpsphinx/blog/main_0000.html" />
</body>
</opml>
"""
[docs]def check(log=False):
"""
Checks the library is working.
It raises an exception.
If you want to disable the logs:
:param log: if True, display information, otherwise
:return: 0 or exception
.. faqref::
:title: Un exemple de FAQ
Simple exemple.
.. exref::
:title: Un exemple tout court.
.. runpython::
:showcode:
from datetime import datetime
print(datetime.now())
:githublink:`%|py|51`
"""
return True
[docs]def _setup_hook(use_print=False):
"""
if this function is added to the module,
the help automation and unit tests call it first before
anything goes on as an initialization step.
:githublink:`%|py|60`
"""
# we can check many things, needed module
# any others things before unit tests are started
if use_print:
print("Success: _setup_hook") # pragma: no cover