.. tacrpy documentation documentation master file, created by
   sphinx-quickstart on Fri Sep 22 12:59:06 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to tacrpy documentation!
================================================

Tacrpy knihovna slouží k práci s daty a vypracování analýz TA ČR. Umožňuje:

* načítat data ze ze "zdroje pravdy" a otevřených dat IS VaVaI (modul data_fetcher)
* předzpracování, příprava a nahrání dat do DataHub (subpackage datahub)
* zpracování textových dat (subpackage nlp)

Getting started
===============

*Instalace knihovny*

.. code-block:: python

   pip install tacrpy

*Načítání dat ze "zdroje pravdy" můžeme pouze v Google Colab prostředí, proto nejdřív potřebujeme získat autentizační údaje*

.. code-block:: python

   # kód k získání authentizačních údajů, k připojení se souborů na Google disku

   from google.colab import auth
   auth.authenticate_user()

   import gspread
   from google.auth import default
   creds, _ = default()

*Načtení a práce s daty v Google Colab prostředí*

.. code-block:: python

   from tacrpy import data_fetcher

   proj = data_fetcher.Projects(creds)

   # získání agregovaných údajů na úrovni veřejných soutěží
   summary_df = proj.summary

   # získání agregovaných údajů na úrovni programů
   summary_df = proj.create_summary(level='prog')

   # filtrování podle programů
   proj_prog_filter = proj.select_programme('FW', 'CK').projects

   # filtrování podle veřejných soutěží
   proj_cfp_filter = proj.select_cfp('TA01', 'TK01', 'CK01').projects

   # filtrování podpořených projektů
   proj_funded = proj.select_funded().projects

   # řetězení jednotlivých filtrů
   proj_filter = proj.select_programme('FW','CK').select_funded().projects

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   tacrpy

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`