<commit_before>pyensae documentation
=====================

.. image:: https://travis-ci.org/sdpython/pyensae.svg?branch=master
    :target: https://travis-ci.org/sdpython/pyensae
    :alt: Build status
    
.. image:: https://badge.fury.io/py/pyensae.svg
    :target: http://badge.fury.io/py/pyensae
    
.. image:: http://img.shields.io/pypi/dm/pyensae.png
    :alt: PYPI Package
    :target: https://pypi.python.org/pypi/pyensae
       
.. image:: http://img.shields.io/github/issues/sdpython/pyensae.png
    :alt: GitHub Issues
    :target: https://github.com/sdpython/pyensae/issues
    
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :alt: MIT License
    :target: http://opensource.org/licenses/MIT            
   
**Links:** `pypi <https://pypi.python.org/pypi/pyensae/>`_,
`github <https://github.com/sdpython/pyensae/>`_,
`documentation <http://www.xavierdupre.fr/app/pyensae/helpsphinx/index.html>`_,
`wheel <http://www.xavierdupre.fr/site2013/index_code.html#pyensae>`_,
`travis <https://travis-ci.org/sdpython/pyensae>`_,
:ref:`l-README`,
:ref:`blog <ap-main-0>`

Description        
-----------

This project contains helpers used at the `ENSAE <http://www.ensae.fr/>`_ 
for teaching purposes but not only.
It requires `github/pyquickhelper <https://github.com/sdpython/pyquickhelper/>`_.

Data used for teachings at the
`ENSAE <http://www.xavierdupre.fr/site2013/enseignements/index.html>`_
are available through function::

    download_data("td8_velib.zip", website = "xd")
    
The data comes from `xavierdupre.fr <http://www.xavierdupre.fr/>`_.


Tutorial
--------

.. toctree::
    :max_depth: 1
    
    all_example
    all_notebooks
        
    
Functionalities
---------------

* retrieve data for practical lessons (see :func:`download_data <pyensae.resources.http_retrieve.download_data>`)
* import a tsv file into a database (see :func:`import_flatfile_into_database <pyensae.sql.database_helper.import_flatfile_into_database>`)
* retrieve stock prices from Yahoo Finance (see :class:`StockPrices <pyensae.finance.astock.StockPrices>`)
* magic commands to easily use SQLite3 from a notebook (see :class:`MagicSQL <pyensae.sql.magic_sql.MagicSQL>`)
* magic commands to access a Cloudera Cluster and run PIG jobs (see :class:`MagicRemoteSSH <pyensae.remote.magic_remote_ssh.MagicRemoteSSH>`)<commit_msg>documentation<commit_after>pyensae documentation
=====================

.. image:: https://travis-ci.org/sdpython/pyensae.svg?branch=master
    :target: https://travis-ci.org/sdpython/pyensae
    :alt: Build status
    
.. image:: https://badge.fury.io/py/pyensae.svg
    :target: http://badge.fury.io/py/pyensae
    
.. image:: http://img.shields.io/pypi/dm/pyensae.png
    :alt: PYPI Package
    :target: https://pypi.python.org/pypi/pyensae
       
.. image:: http://img.shields.io/github/issues/sdpython/pyensae.png
    :alt: GitHub Issues
    :target: https://github.com/sdpython/pyensae/issues
    
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :alt: MIT License
    :target: http://opensource.org/licenses/MIT            
   
**Links:** `pypi <https://pypi.python.org/pypi/pyensae/>`_,
`github <https://github.com/sdpython/pyensae/>`_,
`documentation <http://www.xavierdupre.fr/app/pyensae/helpsphinx/index.html>`_,
`wheel <http://www.xavierdupre.fr/site2013/index_code.html#pyensae>`_,
`travis <https://travis-ci.org/sdpython/pyensae>`_,
:ref:`l-README`,
:ref:`blog <ap-main-0>`

Description        
-----------

This project contains helpers used at the `ENSAE <http://www.ensae.fr/>`_ 
for teaching purposes but not only.
It requires `github/pyquickhelper <https://github.com/sdpython/pyquickhelper/>`_.

Data used for teachings at the
`ENSAE <http://www.xavierdupre.fr/site2013/enseignements/index.html>`_
are available through function::

    download_data("td8_velib.zip", website = "xd")
    
The data comes from `xavierdupre.fr <http://www.xavierdupre.fr/>`_.


Tutorial
--------

.. toctree::
    :maxdepth: 1
    
    all_example
    all_notebooks
        
    
Functionalities
---------------

* retrieve data for practical lessons (see :func:`download_data <pyensae.resources.http_retrieve.download_data>`)
* import a tsv file into a database (see :func:`import_flatfile_into_database <pyensae.sql.database_helper.import_flatfile_into_database>`)
* retrieve stock prices from Yahoo Finance (see :class:`StockPrices <pyensae.finance.astock.StockPrices>`)
* magic commands to easily use SQLite3 from a notebook (see :class:`MagicSQL <pyensae.sql.magic_sql.MagicSQL>`)
* magic commands to access a Cloudera Cluster and run PIG jobs (see :class:`MagicRemoteSSH <pyensae.remote.magic_remote_ssh.MagicRemoteSSH>`)
{'fraction_non_alphanumeric': 0.16542315071413344, 'fraction_numerical': 0.005116179918993818, 'mean_word_length': 3.734611503531786, 'pattern_counts': {'":': 0, '<': 33, '<?xml version=': 0, '>': 33, 'https://': 20, 'lorem ipsum': 0, 'www.': 10, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '903331', 'n_tokens_mistral': 1693, 'n_tokens_neox': 1615, 'n_words': 297}