Metadata-Version: 2.1
Name: olapy
Version: 0.8.2
Summary: OlaPy, an experimental OLAP engine based on Pandas
Home-page: https://github.com/abilian/olapy
Author: Abilian SAS
Requires-Python: >=3.8,<4
Classifier: Development Status :: 3 - Alpha
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: etl
Provides-Extra: spark
Requires-Dist: attrs
Requires-Dist: awesome-slugify; extra == "etl"
Requires-Dist: bonobo-sqlalchemy (<0.6.1); extra == "etl"
Requires-Dist: bonobo; extra == "etl"
Requires-Dist: click
Requires-Dist: lxml
Requires-Dist: pandas
Requires-Dist: pyspark (<3); extra == "spark"
Requires-Dist: python-dotenv; extra == "etl"
Requires-Dist: pyyaml (>=4.2b1)
Requires-Dist: regex
Requires-Dist: spyne (>=2.13,<3.0)
Requires-Dist: sqlalchemy
Requires-Dist: typing
Requires-Dist: whistle (<1.0.1); extra == "etl"
Requires-Dist: xmlwitch
Description-Content-Type: text/x-rst

OlaPy, an experimental OLAP engine based on Pandas
==================================================

About
-----

**OlaPy** is an OLAP_ engine based on Python, which gives you a set of tools for the development of reporting and analytical
applications, multidimensional analysis, and browsing of aggregated data with MDX_ and XMLA_ support.


.. _OLAP: https://en.wikipedia.org/wiki/Online_analytical_processing
.. _MDX: https://en.wikipedia.org/wiki/MultiDimensional_eXpressions
.. _XMLA: https://en.wikipedia.org/wiki/XML_for_Analysis

`Documentation <https://olapy.readthedocs.io/en/latest/>`_

.. image:: https://raw.githubusercontent.com/abilian/olapy/master/docs/pictures/olapy.gif

Status
~~~~~~

This project is currently a research prototype, not suited for production use.


.. image:: https://static.pepy.tech/badge/olapy
   :target: https://pepy.tech/project/olapy

Licence
~~~~~~~

This project is currently licenced under the LGPL v3 licence.

Installation
------------

Install from PyPI
~~~~~~~~~~~~~~~~~

You can install it directly from the `Python Package Index <https://pypi.python.org/pypi/olapy>`_::

    pip install olapy


Install from Github
~~~~~~~~~~~~~~~~~~~

The project sources are stored in `Github repository <https://github.com/abilian/olapy>`_.

Download from Github::

    git clone git://github.com/abilian/olapy.git


To set up the application, run, ideally in a virtualenv::

    cd olapy
    python setup.py install

or just::

    pip install -e .

**[OPTIONAL]**

you can use `Spark <https://spark.apache.org/docs/0.9.0/python-programming-guide.html>`_  instead of `Pandas <https://pandas.pydata.org/>`_, to do so, you need just to install it::

    pip install pyspark

and if you want to go back to pandas just uninstall spark with::

    pip uninstall pyspark

Usage
-----

Before running OlaPy, you need to initialize it with::

    olapy init

and then you can run the server with::

    olapy runserver


and then from excel, open new spreadsheet and go to : Data -> From Other Sources -> From Analysis Services and use http://127.0.0.1:8000/ as server name and click next, then you can chose one of default olapy demo cubes (sales, foodmart...) and finish.

that's it ! now you can play with data


Developing
----------

This project must adhere to the `Abilian Developer Guide <http://abilian-developer-guide.readthedocs.io/>`_.

Pull requests are welcome.

Tests
~~~~~

To run tests, run::

    pytest tests

or simply (on Unix-like systems)::

    make test


Credits
-------

This project is developed by `Abilian SAS <https://www.abilian.com>`_ and partially funded by the French Government through the `Wendelin <http://www.wendelin.io/>`_ project and the `Investissement d'avenir <http://www.gouvernement.fr/investissements-d-avenir-cgi>`_ programme.

