Metadata-Version: 2.0
Name: pyensae
Version: 1.2.717
Summary: Helpers for teaching purposes (includes sqllite helpers)
Home-page: http://www.xavierdupre.fr/app/pyensae/helpsphinx/index.html
Author: Xavier Dupré
Author-email: xavier.dupre@gmail.com
License: MIT
Download-URL: https://github.com/sdpython/pyensae/
Description-Content-Type: UNKNOWN
Keywords: pyensae,ENSAE,sqllite,database,teachings
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 5 - Production/Stable
Requires-Dist: pyquickhelper (>=1.5.2259)
Provides-Extra: datasource.convert
Requires-Dist: dbread; extra == 'datasource.convert'
Provides-Extra: datasource.data_velib
Requires-Dist: moviepy; extra == 'datasource.data_velib'
Provides-Extra: datasource.linkedin_access
Requires-Dist: python3-linkedin; extra == 'datasource.linkedin_access'
Provides-Extra: finance
Requires-Dist: pandas-datareader; extra == 'finance'
Provides-Extra: graph_helper
Requires-Dist: matplotlib; extra == 'graph_helper'
Requires-Dist: blockdiag; extra == 'graph_helper'
Provides-Extra: languages
Requires-Dist: antlr4-python3-runtime; extra == 'languages'
Provides-Extra: notebook_helper.folium_helper
Requires-Dist: folium; extra == 'notebook_helper.folium_helper'
Provides-Extra: notebook_helper.magic_notebook
Requires-Dist: qgrid; extra == 'notebook_helper.magic_notebook'


.. _l-README:

README
======

.. image:: https://travis-ci.org/sdpython/pyensae.svg?branch=master
    :target: https://travis-ci.org/sdpython/pyensae
    :alt: Build status

.. image:: https://ci.appveyor.com/api/projects/status/jioxwx1igwbqwa28?svg=true
    :target: https://ci.appveyor.com/project/sdpython/pyensae
    :alt: Build Status Windows

.. image:: https://circleci.com/gh/sdpython/pyensae/tree/master.svg?style=svg
    :target: https://circleci.com/gh/sdpython/pyensae/tree/master

.. image:: https://badge.fury.io/py/pyensae.svg
    :target: http://badge.fury.io/py/pyensae

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
    :alt: MIT License
    :target: http://opensource.org/licenses/MIT

.. image:: https://requires.io/github/sdpython/pyensae/requirements.svg?branch=master
     :target: https://requires.io/github/sdpython/pyensae/requirements/?branch=master
     :alt: Requirements Status

.. image:: https://codecov.io/github/sdpython/pyensae/coverage.svg?branch=master
    :target: https://codecov.io/github/sdpython/pyensae?branch=master

.. image:: http://img.shields.io/github/issues/sdpython/pyensae.png
    :alt: GitHub Issues
    :target: https://github.com/sdpython/pyensae/issues

.. image:: https://badge.waffle.io/sdpython/pyensae.png?label=ready&title=Ready
    :alt: Waffle
    :target: https://waffle.io/sdpython/pyensae

.. image:: http://www.xavierdupre.fr/app/pyensae/helpsphinx/_images/nbcov.png
    :target: http://www.xavierdupre.fr/app/pyensae/helpsphinx/all_notebooks_coverage.html
    :alt: Notebook Coverage

**Links:**

* `GitHub/pyensae <https://github.com/sdpython/pyensae/>`_
* `documentation <http://www.xavierdupre.fr/app/pyensae/helpsphinx/index.html>`_
* `Blog <http://www.xavierdupre.fr/app/pyensae/helpsphinx/blog/main_0000.html#ap-main-0>`_

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

This project contains helpers used at the `ENSAE <http://www.ensae.fr/>`_
for teachings available at
`ENSAE - Programmation - Xavier Dupré <http://www.xavierdupre.fr/app/ensae_teaching_cs/helpsphinx3/index.html>`_.

Functionalities
---------------

* retrieve data for practical lessons
* import a tsv file into a database
* retrieve stock prices from Yahoo Finance
* magic commands to easily use SQLite3 from a notebook

Dependencies
------------

* `numpy <http://www.numpy.org/>`_
* `pandas <http://pandas.pydata.org/>`_
* `pyquickhelper <https://pypi.python.org/pypi/pyquickhelper/>`_

Class *StockPrices* requires:

* `dateutil <https://pypi.python.org/pypi/python-dateutil>`_
* `six <https://pypi.python.org/pypi/six>`_

The function *register_magics* defines magic commands
to send commands to a remote commands through a SSH connection:

* ``%remote_open``, ``%remote_close``
* ``%remote_cmd``, ``%remote_up``, ``%remote_down``

The magic commands will be automatically enabled if the module is imported from a notebook.

Contributions
-------------

Started in 2013/08.

* First contributor: `Xavier Dupré <http://www.xavierdupre.fr/>`_.
* Others contributors: ENSAE's students.

=======
History
=======

1.2.9999 (20??-??-??)
=====================

**Features**

* `16`: split *pyensae* into *pyenbc* for remote access to clusters
  and the rest

1.1.689 (2017-11-28)
====================

**Bug**

* `15`: StockPrices: start and end date are not taking into account with the default data provider

**Features**

* `9`: switch from Yahoo Finance to Google as the default provider
  for financial data
* `11`: create graph image with blockdiag
* `13`: add a class *TableFormula* as an example to extend pandas dataframe


