Metadata-Version: 2.1
Name: iccas
Version: 0.1.1
Summary: Helper library for the ICCAS dataset
Home-page: https://github.com/janLuke/iccas-python
Author: Gianluca Gippetto
Author-email: gianluca.gippetto@gmail.com
License: MIT license
Description: ====================
        ICCAS Python Helper
        ====================
        
        
        .. image:: https://img.shields.io/pypi/v/iccas.svg
            :target: https://pypi.python.org/pypi/iccas
        
        .. image:: https://travis-ci.com/janLuke/iccas-python.svg?branch=main
            :target: https://travis-ci.com/janLuke/iccas-python
        
        .. image:: https://readthedocs.org/projects/iccas/badge/?version=latest
            :target: https://iccas.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        .. image:: https://mybinder.org/badge_logo.svg
            :target: https://mybinder.org/v2/gh/janLuke/iccas-python/main?filepath=notebooks
        
        This repository contains:
        
        - a helper package to get the `ICCAS dataset`_ (Italian Coronavirus Cases by
          Age group and Sex) and work with it;
        - some Jupyter notebooks that you can run on Binder clicking the badge above.
        
        
        The package
        -----------
        The package includes several submodules:
        
        .. list-table::
            :header-rows: 1
            :widths: 30 70
        
            * - Module
              - Description
            * - ``loading``
              - Obtain, cache and load the dataset(s)
            * - ``processing``
              - Data (pre)processing. Fix data inconsistencies, resample data with interpolation.
            * - ``queries``
              - Select subsets of data, aggregate or extract useful values.
            * - ``charts``
              - Draw charts and animations (in Italian or English).
        
        To install the package::
        
            pip install iccas
        
        If you want to use the CLI::
        
            pip install iccas[cli]
        
        
        * Free software: MIT license
        * Documentation: https://iccas.readthedocs.io.
        
        .. _`ICCAS dataset`: https://github.com/janLuke/iccas-dataset/
        
        
        Notebooks
        ----------
        Notebooks text is written in Italian but charts are available in English as well.
        You just need to run in the first cell::
        
            ic.set_locale('en')
        
        To run notebooks locally, you need to `install jupyter`_ , for example with::
        
            pip install jupyterlab
        
        Then::
        
            pip install -r binder/requirements.txt
            ./binder/postBuild
        
        .. _install jupyter: https://jupyter.org/install
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2020-10-07)
        ------------------
        
        * First release on PyPI.
        
Keywords: iccas
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Provides-Extra: cli
