diff --git a/dev/contribute.html b/dev/contribute.html index 2d9beee..91ff1dc 100644 --- a/dev/contribute.html +++ b/dev/contribute.html @@ -66,7 +66,7 @@

Modules

diff --git a/dev/genindex.html b/dev/genindex.html index bfd48e8..4819b28 100644 --- a/dev/genindex.html +++ b/dev/genindex.html @@ -56,7 +56,7 @@

Modules

@@ -120,27 +120,43 @@

C

  • category (pystatis.find.Results attribute)
    • -
  • clear_cache() (in module pystatis.cache) +
  • change_password() (in module pystatis.profile)
    • +
  • clear_cache() (in module pystatis) + +

    • D

    - +
    @@ -224,6 +256,8 @@

    M

    module @@ -253,6 +291,37 @@

    P

    + + - - @@ -303,8 +386,12 @@

    P

    Q

    @@ -312,6 +399,8 @@

    R

    S

    T

    +

    V

    W

    @@ -132,6 +132,16 @@

    Python Module Index

    + + + + + +
    + +
  • Overall Module contents
    • -
  • Overall Module contents
    • diff --git a/dev/install.html b/dev/install.html index c5cc3ff..40b2d51 100644 --- a/dev/install.html +++ b/dev/install.html @@ -59,7 +59,7 @@

    Modules

    diff --git a/dev/license.html b/dev/license.html index 814cb09..2746368 100644 --- a/dev/license.html +++ b/dev/license.html @@ -59,7 +59,7 @@

    Modules

    diff --git a/dev/objects.inv b/dev/objects.inv index b207a1e..1741844 100644 Binary files a/dev/objects.inv and b/dev/objects.inv differ diff --git a/dev/py-modindex.html b/dev/py-modindex.html index 9de7de4..71a6349 100644 --- a/dev/py-modindex.html +++ b/dev/py-modindex.html @@ -59,7 +59,7 @@

    Modules

    @@ -100,7 +100,7 @@

    Python Module Index

    		 - pystatis + pystatis
        pystatis.http_helper
        + pystatis.profile +
        + pystatis.table +
    diff --git a/dev/pystatis.html b/dev/pystatis.html index 4217e8c..83a30b4 100644 --- a/dev/pystatis.html +++ b/dev/pystatis.html @@ -129,11 +129,56 @@
  • start_job()
    • -
  • pystatis.profile module
    • -
  • pystatis.table module
    • +
  • pystatis.profile module +
    • +
  • pystatis.table module +
    • + + +
  • Overall Module contents
    • -
  • Overall Module contents
    • @@ -877,15 +922,452 @@

    pystatis.custom_exceptions module -

    pystatis.profile module

    +
    +

    pystatis.profile module

    +

    Module provides wrapper for Profile GENESIS REST-API functions.

    +
    +
    +pystatis.profile.change_password(db_name, new_password)
    +

    Changes Genesis REST-API password and updates local config.

    +
    +
    Parameters:
    +
      +

    • new_password (str) – New password for the Genesis REST-API

      • +

    • db_name (str) – Database for which the password should be changed (genesis, zensus, regio)

      • +
    +
    +
    Returns:
    +

    text response from Destatis

    +
    +
    Return type:
    +

    str

    +
    +
    +
    + +
    +
    +pystatis.profile.remove_result(name, area='all')
    +

    Remove ‘Ergebnistabellen’ from the the permission space ‘area’. +Should only apply for manually saved data, visible in ‘Meine Tabellen’ in the Web Interface.

    +
    +
    Parameters:
    +
      +

    • name (str) – ‘Ergebnistabelle’ to be removed

      • +

    • area (str) – permission area in which the ‘Ergebnistabelle’ resides

      • +
    +
    +
    Returns:
    +

    text response from Destatis

    +
    +
    Return type:
    +

    str

    +
    +
    +
    +
    -
    -

    pystatis.table module

    +
    +

    pystatis.table module

    +

    Module contains business logic related to destatis tables.

    +
    +
    +class pystatis.table.Table(name)
    +

    Bases: object

    +

    A wrapper class holding all relevant data and metadata about a given table.

    +
    +
    Parameters:
    +
      +

    • name (str) – The unique identifier of this table.

      • +

    • raw_data (str) – The raw tablefile data as returned by the /data/table endpoint.

      • +

    • data (pd.DataFrame) – The parsed data as a pandas data frame.

      • +

    • metadata (dict) – Metadata as returned by the /metadata/table endpoint.

      • +
    +
    +
    +
    +
    +get_data(area='all', prettify=True, **kwargs)
    +

    Downloads raw data and metadata from GENESIS-Online.

    +

    Additional keyword arguments are passed on to the GENESIS-Online GET request for tablefile.

    +
    +
    Parameters:
    +
      +

    • area (str, optional) – Area to search for the object in GENESIS-Online. Defaults to “all”.

      • +

    • prettify (bool, optional) – Reformats the table into a readable format. Defaults to True.

      • +
    +
    +
    +
    + +
    +
    +static parse_genesis_table(data)
    +
    +
    Parameters:
    +

    data (DataFrame) –

    +
    +
    Return type:
    +

    DataFrame

    +
    +
    +
    + +
    +
    +static parse_regio_table(data)
    +
    +
    Parameters:
    +

    data (DataFrame) –

    +
    +
    Return type:
    +

    DataFrame

    +
    +
    +
    + +
    +
    +static parse_zensus_table(data)
    +
    +
    Parameters:
    +

    data (DataFrame) –

    +
    +
    Return type:
    +

    DataFrame

    +
    +
    +
    + +
    +
    +static prettify_table(data, db)
    +

    Reformat the data into a more readable table

    +
    +
    Parameters:
    +
      +

    • data (pd.DataFrame) – A pandas dataframe created from raw_data

      • +

    • db (str) – The name of the database.

      • +
    +
    +
    Returns:
    +

    Formatted dataframe that omits all unnecessary Code columns +and includes informative columns names

    +
    +
    Return type:
    +

    pd.DataFrame

    +
    +
    +
    + +
    +
    -
    -

    Overall Module contents

    +
    +

    Overall Module contents

    +

    pystatis is a Python wrapper for the GENESIS web service interface (API).

    +

    Basic usage:

    +

    `python +import pystatis as pstat +print("Version:", pstat.__version__) +`

    +
    +
    +class pystatis.Cube(name)
    +

    Bases: object

    +

    A wrapper class holding all relevant data and metadata about a given cube.

    +
    +
    Parameters:
    +
      +

    • name (str) – The unique identifier of this cube.

      • +

    • raw_data (str) – The raw cubefile data as returned by the /data/cubfile endpoint.

      • +

    • data (pd.DataFrame) – The parsed data as a pandas data frame.

      • +

    • cube (dict) – Metadata as returned by the /data/cubefile endpoint.

      • +

    • metadata (dict) – Metadata as returned by the /metadata/cube endpoint.

      • +
    +
    +
    +
    +
    +get_data(area='all', **kwargs)
    +

    Downloads raw data and metadata from GENESIS-Online.

    +

    Additional keyword arguments are passed on to the GENESIS-Online GET request for cubefiles.

    +
    +
    Parameters:
    +

    area (str, optional) – Area to search for the object in GENESIS-Online. Defaults to “all”.

    +
    +
    +
    + +
    + +
    +
    +class pystatis.Find(query, db_name, top_n_preview=5)
    +

    Bases: object

    +

    A class representing the find object that includes Result objects for variables, statistics, cubes and tables.

    +
    +
    Parameters:
    +
      +

    • query (str) –

      • +

    • db_name (str) –

      • +

    • top_n_preview (int) –

      • +
    +
    +
    +
    +
    +query
    +

    The query that is provided to find endpoint.

    +
    +
    Type:
    +

    str

    +
    +
    +
    + +
    +
    +db_name
    +

    The database that is used for the query. +One of “genesis”, “zensus”, “regio”.

    +
    +
    Type:
    +

    str

    +
    +
    +
    + +
    +
    +statistics
    +

    Statistics that match with the query.

    +
    +
    Type:
    +

    Results

    +
    +
    +
    + +
    +
    +tables
    +

    Tables that match with the query.

    +
    +
    Type:
    +

    Results

    +
    +
    +
    + +
    +
    +variables
    +

    Variables that match with the query.

    +
    +
    Type:
    +

    Results

    +
    +
    +
    + +
    +
    +cubes
    +

    Cubes that match with the query.

    +
    +
    Type:
    +

    Results

    +
    +
    +
    + +
    +
    +run()
    +

    Queries the API and prints summary.

    +
    + +
    +
    +summary()
    +

    Prints summary of all results.

    +
    + +
    +
    +run()
    +
    + +
    +
    +summary()
    +
    +
    Returns:
    +

    String that contains summary statistics.

    +
    +
    Return type:
    +

    summary_string

    +
    +
    +
    + +
    + +
    +
    +class pystatis.Table(name)
    +

    Bases: object

    +

    A wrapper class holding all relevant data and metadata about a given table.

    +
    +
    Parameters:
    +
      +

    • name (str) – The unique identifier of this table.

      • +

    • raw_data (str) – The raw tablefile data as returned by the /data/table endpoint.

      • +

    • data (pd.DataFrame) – The parsed data as a pandas data frame.

      • +

    • metadata (dict) – Metadata as returned by the /metadata/table endpoint.

      • +
    +
    +
    +
    +
    +get_data(area='all', prettify=True, **kwargs)
    +

    Downloads raw data and metadata from GENESIS-Online.

    +

    Additional keyword arguments are passed on to the GENESIS-Online GET request for tablefile.

    +
    +
    Parameters:
    +
      +

    • area (str, optional) – Area to search for the object in GENESIS-Online. Defaults to “all”.

      • +

    • prettify (bool, optional) – Reformats the table into a readable format. Defaults to True.

      • +
    +
    +
    +
    + +
    +
    +static parse_genesis_table(data)
    +
    +
    Parameters:
    +

    data (DataFrame) –

    +
    +
    Return type:
    +

    DataFrame

    +
    +
    +
    + +
    +
    +static parse_regio_table(data)
    +
    +
    Parameters:
    +

    data (DataFrame) –

    +
    +
    Return type:
    +

    DataFrame

    +
    +
    +
    + +
    +
    +static parse_zensus_table(data)
    +
    +
    Parameters:
    +

    data (DataFrame) –

    +
    +
    Return type:
    +

    DataFrame

    +
    +
    +
    + +
    +
    +static prettify_table(data, db)
    +

    Reformat the data into a more readable table

    +
    +
    Parameters:
    +
      +

    • data (pd.DataFrame) – A pandas dataframe created from raw_data

      • +

    • db (str) – The name of the database.

      • +
    +
    +
    Returns:
    +

    Formatted dataframe that omits all unnecessary Code columns +and includes informative columns names

    +
    +
    Return type:
    +

    pd.DataFrame

    +
    +
    +
    + +
    + +
    +
    +pystatis.clear_cache(name=None)
    +

    Clean the data cache completely or just a specified name.

    +
    +
    Parameters:
    +

    name (str, optional) – Unique name to be deleted from cached data.

    +
    +
    Return type:
    +

    None

    +
    +
    +
    + +
    +
    +pystatis.logincheck(db_name)
    +

    Wrapper method which constructs a URL for testing the Destatis API +logincheck method, which tests the login credentials (from the config.ini).

    +
    +
    Parameters:
    +

    db_name (str) – Name of the database to login to

    +
    +
    Returns:
    +

    text logincheck response from Destatis

    +
    +
    Return type:
    +

    str

    +
    +
    +
    + +
    +
    +pystatis.setup_credentials()
    +

    Setup credentials for all supported databases.

    +
    +
    Return type:
    +

    None

    +
    +
    +
    + +
    +
    +pystatis.whoami(db_name)
    +

    Wrapper method which constructs a URL for testing the Destatis API +whoami method, which returns host name and IP address.

    +
    +
    Parameters:
    +

    db_name (str) – Name of the database to test

    +
    +
    Returns:
    +

    text test response from Destatis

    +
    +
    Return type:
    +

    str

    +
    +
    +
    +
    diff --git a/dev/roadmap.html b/dev/roadmap.html index a463d33..d92461b 100644 --- a/dev/roadmap.html +++ b/dev/roadmap.html @@ -59,7 +59,7 @@

    Modules

    diff --git a/dev/search.html b/dev/search.html index 229d8da..d1f07e7 100644 --- a/dev/search.html +++ b/dev/search.html @@ -59,7 +59,7 @@

    Modules

    diff --git a/dev/searchindex.js b/dev/searchindex.js index 98f06af..e52dd65 100644 --- a/dev/searchindex.js +++ b/dev/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["contribute", "index", "install", "license", "pystatis", "roadmap", "start", "use"], "filenames": ["contribute.rst", "index.rst", "install.rst", "license.rst", "pystatis.rst", "roadmap.rst", "start.rst", "use.rst"], "titles": ["Developer Information", "pystatis", "Installation", "License", "pystatis package", "Roadmap", "Getting started", "Usage"], "terms": {"contribut": 0, "thi": [0, 2, 4, 5, 6, 7], "project": [0, 7], "ar": [0, 1, 4, 7], "highli": 0, "appreci": 0, "you": [0, 1, 2, 4, 6], "can": [0, 2, 4, 5, 6, 7], "either": [0, 4, 6, 7], "contact": 0, "maintain": 0, "directli": [0, 1], "creat": [0, 4, 6], "pull": 0, "request": [0, 4], "your": [0, 1, 6], "propos": 0, "chang": [0, 4, 7], "fork": 0, "featur": [0, 1], "branch": [0, 7], "git": 0, "checkout": 0, "b": 0, "descript": 0, "name": [0, 4, 7], "commit": 0, "m": 0, "ad": 0, "newfeatur": 0, "push": 0, "remot": 0, "origin": 0, "open": 0, "merg": 0, "To": [0, 1, 6], "pleas": [0, 6, 7], "follow": [0, 1, 6, 7], "step": 0, "instal": [0, 1, 7], "miniforg": 0, "new": [0, 4], "virtual": 0, "environ": [0, 4], "us": [0, 4, 5, 6, 7], "conda": 0, "run": [0, 4, 7], "n": 0, "pystati": [0, 2, 6, 7], "python": [0, 1], "3": [0, 7], "11": 0, "choos": 0, "anoth": 0, "version": [0, 2, 5], "long": 0, "i": [0, 1, 4, 5, 6, 7], "support": [0, 1, 4, 5, 6, 7], "packag": [0, 1, 2, 7], "see": [0, 3, 6], "pyproject": 0, "toml": 0, "poetri": 0, "insid": 0, "clone": 0, "repositori": 0, "via": [0, 2, 7], "root": [0, 4, 7], "directori": [0, 4, 7], "all": [0, 1, 4, 6, 7], "depend": 0, "current": [0, 1, 4, 7], "info": 0, "detail": [0, 6, 7], "receiv": 0, "addit": [0, 4], "ha": [0, 4], "well": [0, 4], "itself": 0, "pre": 0, "activ": 0, "hook": 0, "prior": 0, "everi": 0, "ensur": 0, "code": [0, 4, 7], "qualiti": 0, "check": [0, 4, 6], "out": [0, 2, 6], "make": [0, 7], "sure": 0, "up": [0, 5, 6], "date": 0, "switch": [0, 1], "c": [0, 7], "If": [0, 2, 4, 6, 7], "possibl": [0, 7], "add": [0, 1], "an": [0, 1, 4], "issu": 0, "number": [0, 4], "do": 0, "pytest": 0, "exist": [0, 4], "test": [0, 4], "still": 0, "through": 0, "It": [0, 7], "import": [0, 2, 7], "call": [0, 1, 4], "so": [0, 5, 7], "system": 0, "": [0, 7], "default": [0, 4], "interpret": 0, "altern": 0, "shell": 0, "let": [0, 1], "session": 0, "afterward": 0, "usual": 0, "without": [0, 4], "ani": [0, 7], "prefix": 0, "leav": 0, "exit": 0, "command": 0, "again": 0, "also": [0, 7], "pass": [0, 4], "trigger": 0, "defin": 0, "config": [0, 1], "yaml": 0, "fail": 0, "declin": 0, "have": [0, 4, 5, 6, 7], "fix": 0, "first": [0, 4], "befor": 0, "pr": 0, "latest": 0, "from": [0, 1, 4, 5, 7], "back": 0, "rebas": 0, "get": [0, 1, 4, 7], "work": [0, 1, 2, 6], "solv": 0, "conflict": 0, "final": 0, "alwai": [0, 4, 5], "against": [0, 6], "target": 0, "learn": [0, 1], "more": [0, 1, 3, 5, 6, 7], "about": [0, 1, 4, 6], "manag": [0, 1], "With": 0, "realpython": 0, "com": 0, "wrapper": [1, 4], "differ": [1, 4], "genesi": [1, 4, 5, 6], "web": [1, 6], "servic": [1, 6], "interfac": [1, 7], "api": [1, 4, 5, 6], "we": [1, 5], "databas": [1, 4, 6], "onlin": [1, 4, 5, 6, 7], "regionaldatenbank": [1, 6], "zensu": [1, 4, 6], "datenbank": 1, "The": [1, 4], "main": [1, 4, 7], "simplifi": 1, "access": 1, "No": 1, "need": 1, "write": [1, 4], "cumbersom": 1, "between": 1, "credenti": [1, 4, 6], "remov": [1, 4], "manual": 1, "handl": [1, 4], "easili": 1, "them": [1, 7], "integr": 1, "workflow": 1, "enabl": 1, "end": 1, "process": 1, "find": 1, "relev": [1, 4], "data": [1, 4, 5, 6], "download": [1, 4, 5, 6], "panda": [1, 4, 7], "instead": 1, "pars": [1, 4, 5, 7], "result": [1, 4, 7], "cach": [1, 5], "product": 1, "despit": 1, "strict": 1, "queri": [1, 4, 7], "limit": 1, "start": [1, 4], "background": [1, 4], "job": [1, 4], "dataset": [1, 5], "big": 1, "refer": 1, "offici": 1, "document": 1, "here": [1, 6, 7], "usag": 1, "model": 1, "right": [1, 5, 6], "clear": 1, "full": 1, "roadmap": 1, "develop": 1, "inform": [1, 3, 4, 7], "contributor": 1, "licens": 1, "cube": [1, 5, 7], "custom_except": 1, "helloworld": [1, 6], "http_helper": 1, "profil": 1, "overal": 1, "index": [1, 4], "search": [1, 4, 7], "page": [1, 7], "pip": 2, "everyth": [2, 6], "correctli": [2, 6], "should": [2, 5], "abl": [2, 6], "like": [2, 4, 7], "print": [2, 4], "__version__": 2, "distribut": 3, "under": [3, 4], "mit": 3, "txt": 3, "below": [4, 7], "submodul": 4, "provid": [4, 5, 6, 7], "function": [4, 7], "decor": 4, "cache_data": 4, "cache_dir": 4, "param": 4, "compress": 4, "archiv": 4, "within": 4, "configur": 4, "store": 4, "zip": 4, "file": 4, "folder": 4, "structur": [4, 7], "endpoint": [4, 6, 7], "method": 4, "hash": 4, "allow": 4, "paramet": 4, "str": 4, "cash": 4, "uniqu": 4, "identifi": 4, "dict": 4, "dictionari": 4, "hold": 4, "actual": 4, "raw": 4, "text": 4, "return": 4, "type": [4, 7], "none": 4, "clear_cach": [4, 7], "clean": [4, 7], "complet": [4, 6, 7], "just": 4, "specifi": [4, 7], "option": 4, "delet": [4, 7], "hit_in_cash": 4, "alreadi": [4, 7], "true": 4, "combin": 4, "bool": 4, "normalize_nam": 4, "normal": 4, "destati": 4, "object": [4, 7], "omit": 4, "id": 4, "read_from_cach": 4, "read": 4, "uncompress": 4, "ini": 4, "core": 4, "which": [4, 6], "user": [4, 5, 6], "home": 4, "set": [4, 6], "variabl": [4, 5, 7], "pystatis_config_dir": 4, "custom": 4, "init_config": 4, "locat": 4, "doe": 4, "linux": 4, "userhom": 4, "window": 4, "when": [4, 7], "load": [4, 7], "time": [4, 5, 7], "empti": 4, "subsequ": 4, "other": [4, 7], "throw": 4, "error": 4, "until": 4, "fill": 4, "config_exist": 4, "create_default_config": 4, "parser": 4, "delete_config": 4, "get_cache_dir": 4, "get_db_identifi": 4, "list": 4, "regex": 4, "pattern": 4, "match": 4, "item": 4, "get_supported_db": 4, "given": 4, "One": 4, "valu": [4, 5], "config_dir": 4, "path": 4, "load_config": 4, "config_fil": 4, "configpars": 4, "setup_credenti": 4, "setup": [4, 6], "write_config": 4, "cubefil": 4, "class": [4, 7], "base": 4, "A": [4, 5, 7], "metadata": [4, 5, 7], "raw_data": 4, "cubfil": 4, "pd": 4, "datafram": 4, "frame": [4, 5, 7], "get_data": [4, 7], "area": 4, "kwarg": 4, "keyword": 4, "argument": 4, "assign_correct_typ": 4, "assign": 4, "correct": 4, "column": 4, "wert": 4, "parse_cub": 4, "same": 4, "qei": 4, "each": [4, 5, 7], "header": [4, 7], "kei": 4, "correspond": 4, "block": 4, "rename_ax": 4, "rename_classifying_vari": 4, "rename_time_vari": 4, "renam": 4, "gener": 4, "ax": 4, "found": 4, "classifi": 4, "implement": [4, 5], "retriev": [4, 5, 7], "db_name": 4, "top_n_preview": 4, "5": 4, "repres": 4, "includ": 4, "statist": [4, 7], "int": 4, "regio": 4, "summari": 4, "string": 4, "contain": [4, 5, 7], "summary_str": 4, "categori": 4, "df": [4, 7], "plural": 4, "e": [4, 7], "g": [4, 7], "get_cod": [4, 7], "row_numb": 4, "get_metadata": [4, 7], "row": 4, "meta": 4, "rest": 4, "logincheck": 4, "construct": 4, "url": 4, "login": [4, 6], "respons": 4, "whoami": 4, "host": [4, 7], "ip": 4, "address": 4, "get_data_from_endpoint": 4, "send": 4, "eg": 4, "catalogu": 4, "tablefil": 4, "get_data_from_resultfil": 4, "job_id": 4, "onc": [4, 5, 6], "finish": 4, "timeout": 4, "reach": 4, "get_job_id_from_respons": 4, "successfulli": 4, "equal": 4, "load_data": 4, "as_json": 4, "fals": 4, "previou": 4, "valid": 4, "json": 4, "union": 4, "start_job": 4, "small": 4, "helper": 4, "few": 5, "idea": 5, "mayb": 5, "futur": 5, "improv": 5, "tabl": [5, 7], "now": [5, 7], "realli": 5, "simpl": 5, "align": [5, 7], "format": 5, "conveni": 5, "mechan": 5, "newer": 5, "than": 5, "matter": 5, "howev": 5, "could": 5, "quit": 5, "challeng": 5, "bad": 5, "good": 5, "consist": [5, 7], "field": 5, "last": 5, "updat": 5, "datetim": 5, "look": 5, "understand": 5, "seri": 5, "regist": 6, "usernam": 6, "password": 6, "authent": 6, "onli": [6, 7], "one": 6, "simpli": 6, "guid": 6, "how": [6, 7], "desir": 6, "For": [6, 7], "studi": [6, 7], "sampl": [6, 7], "notebook": [6, 7], "multipl": 7, "element": 7, "summar": 7, "imag": 7, "multi": 7, "dimension": 7, "deriv": 7, "logic": 7, "unit": 7, "offer": 7, "piec": 7, "behind": 7, "scene": 7, "exampl": 7, "roh\u00f6l": 7, "initi": 7, "1": 7, "2": 7, "overview": 7, "case": 7, "form": 7, "both": 7, "been": 7, "close": 7, "t": 7, "21311": 7, "0001": 7, "yet": 7, "fetch": 7, "next": 7, "22922kj1141": 7, "put": 7, "automat": 7, "dev": 7, "github": 7, "built": 7, "local": 7, "cd": 7, "doc": 7, "html": 7, "besid": 7, "docstr": 7, "individu": 7, "modul": 7, "mirror": 7, "most": 7, "readm": 7, "crucial": 7, "reli": 7, "section": 7, "care": 7, "sphinx": 7}, "objects": {"pystatis": [[4, 0, 0, "-", "cache"], [4, 0, 0, "-", "config"], [4, 0, 0, "-", "cube"], [4, 0, 0, "-", "find"], [4, 0, 0, "-", "helloworld"], [4, 0, 0, "-", "http_helper"]], "pystatis.cache": [[4, 1, 1, "", "cache_data"], [4, 1, 1, "", "clear_cache"], [4, 1, 1, "", "hit_in_cash"], [4, 1, 1, "", "normalize_name"], [4, 1, 1, "", "read_from_cache"]], "pystatis.config": [[4, 1, 1, "", "config_exists"], [4, 1, 1, "", "create_default_config"], [4, 1, 1, "", "delete_config"], [4, 1, 1, "", "get_cache_dir"], [4, 1, 1, "", "get_db_identifiers"], [4, 1, 1, "", "get_supported_db"], [4, 1, 1, "", "init_config"], [4, 1, 1, "", "load_config"], [4, 1, 1, "", "setup_credentials"], [4, 1, 1, "", "write_config"]], "pystatis.cube": [[4, 2, 1, "", "Cube"], [4, 1, 1, "", "assign_correct_types"], [4, 1, 1, "", "parse_cube"], [4, 1, 1, "", "rename_axes"]], "pystatis.cube.Cube": [[4, 3, 1, "", "get_data"]], "pystatis.find": [[4, 2, 1, "", "Find"], [4, 2, 1, "", "Results"]], "pystatis.find.Find": [[4, 4, 1, "", "cubes"], [4, 4, 1, "", "db_name"], [4, 4, 1, "", "query"], [4, 3, 1, "id0", "run"], [4, 4, 1, "", "statistics"], [4, 3, 1, "id1", "summary"], [4, 4, 1, "", "tables"], [4, 4, 1, "", "variables"]], "pystatis.find.Results": [[4, 4, 1, "", "category"], [4, 4, 1, "", "db_name"], [4, 4, 1, "", "df"], [4, 3, 1, "id2", "get_code"], [4, 3, 1, "id3", "get_metadata"]], "pystatis.helloworld": [[4, 1, 1, "", "logincheck"], [4, 1, 1, "", "whoami"]], "pystatis.http_helper": [[4, 1, 1, "", "get_data_from_endpoint"], [4, 1, 1, "", "get_data_from_resultfile"], [4, 1, 1, "", "get_job_id_from_response"], [4, 1, 1, "", "load_data"], [4, 1, 1, "", "start_job"]]}, "objtypes": {"0": "py:module", "1": "py:function", "2": "py:class", "3": "py:method", "4": "py:attribute"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"], "2": ["py", "class", "Python class"], "3": ["py", "method", "Python method"], "4": ["py", "attribute", "Python attribute"]}, "titleterms": {"develop": 0, "inform": 0, "contributor": 0, "dev": 0, "env": 0, "setup": 0, "workflow": 0, "pystati": [1, 4], "content": [1, 4], "modul": [1, 4], "indic": 1, "tabl": [1, 4], "instal": 2, "licens": 3, "packag": 4, "cach": [4, 7], "config": 4, "cube": 4, "custom_except": 4, "find": [4, 7], "helloworld": 4, "http_helper": 4, "profil": 4, "overal": 4, "roadmap": 5, "get": 6, "start": 6, "usag": 7, "The": 7, "genesi": 7, "data": 7, "model": 7, "right": 7, "download": 7, "clear": 7, "full": 7, "document": 7}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Developer Information": [[0, "developer-information"]], "Contributor information": [[0, "contributor-information"]], "Dev env setup": [[0, "dev-env-setup"]], "Workflow": [[0, "workflow"]], "pystatis": [[1, "pystatis"]], "Contents": [[1, null]], "Modules": [[1, null]], "Indices and tables": [[1, "indices-and-tables"]], "Installation": [[2, "installation"]], "License": [[3, "license"]], "pystatis package": [[4, "pystatis-package"]], "pystatis.cache module": [[4, "module-pystatis.cache"]], "pystatis.config module": [[4, "module-pystatis.config"]], "pystatis.cube module": [[4, "module-pystatis.cube"]], "pystatis.custom_exceptions module": [[4, "pystatis-custom-exceptions-module"]], "pystatis.find module": [[4, "module-pystatis.find"]], "pystatis.helloworld module": [[4, "module-pystatis.helloworld"]], "pystatis.http_helper module": [[4, "module-pystatis.http_helper"]], "pystatis.profile module": [[4, "pystatis-profile-module"]], "pystatis.table module": [[4, "pystatis-table-module"]], "Overall Module contents": [[4, "overall-module-contents"]], "Roadmap": [[5, "roadmap"]], "Getting started": [[6, "getting-started"]], "Usage": [[7, "usage"]], "The GENESIS data model": [[7, "the-genesis-data-model"]], "Find the right data": [[7, "find-the-right-data"]], "Download data": [[7, "download-data"]], "Clear Cache": [[7, "clear-cache"]], "Full documentation": [[7, "full-documentation"]]}, "indexentries": {"cube (class in pystatis.cube)": [[4, "pystatis.cube.Cube"]], "find (class in pystatis.find)": [[4, "pystatis.find.Find"]], "results (class in pystatis.find)": [[4, "pystatis.find.Results"]], "assign_correct_types() (in module pystatis.cube)": [[4, "pystatis.cube.assign_correct_types"]], "cache_data() (in module pystatis.cache)": [[4, "pystatis.cache.cache_data"]], "category (pystatis.find.results attribute)": [[4, "pystatis.find.Results.category"]], "clear_cache() (in module pystatis.cache)": [[4, "pystatis.cache.clear_cache"]], "config_exists() (in module pystatis.config)": [[4, "pystatis.config.config_exists"]], "create_default_config() (in module pystatis.config)": [[4, "pystatis.config.create_default_config"]], "cubes (pystatis.find.find attribute)": [[4, "pystatis.find.Find.cubes"]], "db_name (pystatis.find.find attribute)": [[4, "pystatis.find.Find.db_name"]], "db_name (pystatis.find.results attribute)": [[4, "pystatis.find.Results.db_name"]], "delete_config() (in module pystatis.config)": [[4, "pystatis.config.delete_config"]], "df (pystatis.find.results attribute)": [[4, "pystatis.find.Results.df"]], "get_cache_dir() (in module pystatis.config)": [[4, "pystatis.config.get_cache_dir"]], "get_code() (pystatis.find.results method)": [[4, "id2"], [4, "pystatis.find.Results.get_code"]], "get_data() (pystatis.cube.cube method)": [[4, "pystatis.cube.Cube.get_data"]], "get_data_from_endpoint() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.get_data_from_endpoint"]], "get_data_from_resultfile() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.get_data_from_resultfile"]], "get_db_identifiers() (in module pystatis.config)": [[4, "pystatis.config.get_db_identifiers"]], "get_job_id_from_response() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.get_job_id_from_response"]], "get_metadata() (pystatis.find.results method)": [[4, "id3"], [4, "pystatis.find.Results.get_metadata"]], "get_supported_db() (in module pystatis.config)": [[4, "pystatis.config.get_supported_db"]], "hit_in_cash() (in module pystatis.cache)": [[4, "pystatis.cache.hit_in_cash"]], "init_config() (in module pystatis.config)": [[4, "pystatis.config.init_config"]], "load_config() (in module pystatis.config)": [[4, "pystatis.config.load_config"]], "load_data() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.load_data"]], "logincheck() (in module pystatis.helloworld)": [[4, "pystatis.helloworld.logincheck"]], "module": [[4, "module-pystatis.cache"], [4, "module-pystatis.config"], [4, "module-pystatis.cube"], [4, "module-pystatis.find"], [4, "module-pystatis.helloworld"], [4, "module-pystatis.http_helper"]], "normalize_name() (in module pystatis.cache)": [[4, "pystatis.cache.normalize_name"]], "parse_cube() (in module pystatis.cube)": [[4, "pystatis.cube.parse_cube"]], "pystatis.cache": [[4, "module-pystatis.cache"]], "pystatis.config": [[4, "module-pystatis.config"]], "pystatis.cube": [[4, "module-pystatis.cube"]], "pystatis.find": [[4, "module-pystatis.find"]], "pystatis.helloworld": [[4, "module-pystatis.helloworld"]], "pystatis.http_helper": [[4, "module-pystatis.http_helper"]], "query (pystatis.find.find attribute)": [[4, "pystatis.find.Find.query"]], "read_from_cache() (in module pystatis.cache)": [[4, "pystatis.cache.read_from_cache"]], "rename_axes() (in module pystatis.cube)": [[4, "pystatis.cube.rename_axes"]], "run() (pystatis.find.find method)": [[4, "id0"], [4, "pystatis.find.Find.run"]], "setup_credentials() (in module pystatis.config)": [[4, "pystatis.config.setup_credentials"]], "start_job() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.start_job"]], "statistics (pystatis.find.find attribute)": [[4, "pystatis.find.Find.statistics"]], "summary() (pystatis.find.find method)": [[4, "id1"], [4, "pystatis.find.Find.summary"]], "tables (pystatis.find.find attribute)": [[4, "pystatis.find.Find.tables"]], "variables (pystatis.find.find attribute)": [[4, "pystatis.find.Find.variables"]], "whoami() (in module pystatis.helloworld)": [[4, "pystatis.helloworld.whoami"]], "write_config() (in module pystatis.config)": [[4, "pystatis.config.write_config"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["contribute", "index", "install", "license", "pystatis", "roadmap", "start", "use"], "filenames": ["contribute.rst", "index.rst", "install.rst", "license.rst", "pystatis.rst", "roadmap.rst", "start.rst", "use.rst"], "titles": ["Developer Information", "pystatis", "Installation", "License", "pystatis package", "Roadmap", "Getting started", "Usage"], "terms": {"contribut": 0, "thi": [0, 2, 4, 5, 6, 7], "project": [0, 7], "ar": [0, 1, 4, 7], "highli": 0, "appreci": 0, "you": [0, 1, 2, 4, 6], "can": [0, 2, 4, 5, 6, 7], "either": [0, 4, 6, 7], "contact": 0, "maintain": 0, "directli": [0, 1], "creat": [0, 4, 6], "pull": 0, "request": [0, 4], "your": [0, 1, 6], "propos": 0, "chang": [0, 4, 7], "fork": 0, "featur": [0, 1], "branch": [0, 7], "git": 0, "checkout": 0, "b": 0, "descript": 0, "name": [0, 4, 7], "commit": 0, "m": 0, "ad": 0, "newfeatur": 0, "push": 0, "remot": 0, "origin": 0, "open": 0, "merg": 0, "To": [0, 1, 6], "pleas": [0, 6, 7], "follow": [0, 1, 6, 7], "step": 0, "instal": [0, 1, 7], "miniforg": 0, "new": [0, 4], "virtual": 0, "environ": [0, 4], "us": [0, 4, 5, 6, 7], "conda": 0, "run": [0, 4, 7], "n": 0, "pystati": [0, 2, 6, 7], "python": [0, 1, 4], "3": [0, 7], "11": 0, "choos": 0, "anoth": 0, "version": [0, 2, 4, 5], "long": 0, "i": [0, 1, 4, 5, 6, 7], "support": [0, 1, 4, 5, 6, 7], "packag": [0, 1, 2, 7], "see": [0, 3, 6], "pyproject": 0, "toml": 0, "poetri": 0, "insid": 0, "clone": 0, "repositori": 0, "via": [0, 2, 7], "root": [0, 4, 7], "directori": [0, 4, 7], "all": [0, 1, 4, 6, 7], "depend": 0, "current": [0, 1, 4, 7], "info": 0, "detail": [0, 6, 7], "receiv": 0, "addit": [0, 4], "ha": [0, 4], "well": [0, 4], "itself": 0, "pre": 0, "activ": 0, "hook": 0, "prior": 0, "everi": 0, "ensur": 0, "code": [0, 4, 7], "qualiti": 0, "check": [0, 4, 6], "out": [0, 2, 6], "make": [0, 7], "sure": 0, "up": [0, 5, 6], "date": 0, "switch": [0, 1], "c": [0, 7], "If": [0, 2, 4, 6, 7], "possibl": [0, 7], "add": [0, 1], "an": [0, 1, 4], "issu": 0, "number": [0, 4], "do": 0, "pytest": 0, "exist": [0, 4], "test": [0, 4], "still": 0, "through": 0, "It": [0, 7], "import": [0, 2, 4, 7], "call": [0, 1, 4], "so": [0, 5, 7], "system": 0, "": [0, 7], "default": [0, 4], "interpret": 0, "altern": 0, "shell": 0, "let": [0, 1], "session": 0, "afterward": 0, "usual": 0, "without": [0, 4], "ani": [0, 7], "prefix": 0, "leav": 0, "exit": 0, "command": 0, "again": 0, "also": [0, 7], "pass": [0, 4], "trigger": 0, "defin": 0, "config": [0, 1], "yaml": 0, "fail": 0, "declin": 0, "have": [0, 4, 5, 6, 7], "fix": 0, "first": [0, 4], "befor": 0, "pr": 0, "latest": 0, "from": [0, 1, 4, 5, 7], "back": 0, "rebas": 0, "get": [0, 1, 4, 7], "work": [0, 1, 2, 6], "solv": 0, "conflict": 0, "final": 0, "alwai": [0, 4, 5], "against": [0, 6], "target": 0, "learn": [0, 1], "more": [0, 1, 3, 4, 5, 6, 7], "about": [0, 1, 4, 6], "manag": [0, 1], "With": 0, "realpython": 0, "com": 0, "wrapper": [1, 4], "differ": [1, 4], "genesi": [1, 4, 5, 6], "web": [1, 4, 6], "servic": [1, 4, 6], "interfac": [1, 4, 7], "api": [1, 4, 5, 6], "we": [1, 5], "databas": [1, 4, 6], "onlin": [1, 4, 5, 6, 7], "regionaldatenbank": [1, 6], "zensu": [1, 4, 6], "datenbank": 1, "The": [1, 4], "main": [1, 4, 7], "simplifi": 1, "access": 1, "No": 1, "need": 1, "write": [1, 4], "cumbersom": 1, "between": 1, "credenti": [1, 4, 6], "remov": [1, 4], "manual": [1, 4], "handl": [1, 4], "easili": 1, "them": [1, 7], "integr": 1, "workflow": 1, "enabl": 1, "end": 1, "process": 1, "find": 1, "relev": [1, 4], "data": [1, 4, 5, 6], "download": [1, 4, 5, 6], "panda": [1, 4, 7], "instead": 1, "pars": [1, 4, 5, 7], "result": [1, 4, 7], "cach": [1, 5], "product": 1, "despit": 1, "strict": 1, "queri": [1, 4, 7], "limit": 1, "start": [1, 4], "background": [1, 4], "job": [1, 4], "dataset": [1, 5], "big": 1, "refer": 1, "offici": 1, "document": 1, "here": [1, 6, 7], "usag": [1, 4], "model": 1, "right": [1, 5, 6], "clear": 1, "full": 1, "roadmap": 1, "develop": 1, "inform": [1, 3, 4, 7], "contributor": 1, "licens": 1, "cube": [1, 5, 7], "custom_except": 1, "helloworld": [1, 6], "http_helper": 1, "profil": 1, "overal": 1, "clear_cach": [1, 4, 7], "logincheck": [1, 4], "setup_credenti": [1, 4], "whoami": [1, 4], "index": [1, 4], "search": [1, 4, 7], "page": [1, 7], "pip": 2, "everyth": [2, 6], "correctli": [2, 6], "should": [2, 4, 5], "abl": [2, 6], "like": [2, 4, 7], "print": [2, 4], "__version__": [2, 4], "distribut": 3, "under": [3, 4], "mit": 3, "txt": 3, "below": [4, 7], "submodul": 4, "provid": [4, 5, 6, 7], "function": [4, 7], "decor": 4, "cache_data": 4, "cache_dir": 4, "param": 4, "compress": 4, "archiv": 4, "within": 4, "configur": 4, "store": 4, "zip": 4, "file": 4, "folder": 4, "structur": [4, 7], "endpoint": [4, 6, 7], "method": 4, "hash": 4, "allow": 4, "paramet": 4, "str": 4, "cash": 4, "uniqu": 4, "identifi": 4, "dict": 4, "dictionari": 4, "hold": 4, "actual": 4, "raw": 4, "text": 4, "return": 4, "type": [4, 7], "none": 4, "clean": [4, 7], "complet": [4, 6, 7], "just": 4, "specifi": [4, 7], "option": 4, "delet": [4, 7], "hit_in_cash": 4, "alreadi": [4, 7], "true": 4, "combin": 4, "bool": 4, "normalize_nam": 4, "normal": 4, "destati": 4, "object": [4, 7], "omit": 4, "id": 4, "read_from_cach": 4, "read": 4, "uncompress": 4, "ini": 4, "core": 4, "which": [4, 6], "user": [4, 5, 6], "home": 4, "set": [4, 6], "variabl": [4, 5, 7], "pystatis_config_dir": 4, "custom": 4, "init_config": 4, "locat": 4, "doe": 4, "linux": 4, "userhom": 4, "window": 4, "when": [4, 7], "load": [4, 7], "time": [4, 5, 7], "empti": 4, "subsequ": 4, "other": [4, 7], "throw": 4, "error": 4, "until": 4, "fill": 4, "config_exist": 4, "create_default_config": 4, "parser": 4, "delete_config": 4, "get_cache_dir": 4, "get_db_identifi": 4, "list": 4, "regex": 4, "pattern": 4, "match": 4, "item": 4, "get_supported_db": 4, "given": 4, "One": 4, "valu": [4, 5], "config_dir": 4, "path": 4, "load_config": 4, "config_fil": 4, "configpars": 4, "setup": [4, 6], "write_config": 4, "cubefil": 4, "class": [4, 7], "base": 4, "A": [4, 5, 7], "metadata": [4, 5, 7], "raw_data": 4, "cubfil": 4, "pd": 4, "datafram": 4, "frame": [4, 5, 7], "get_data": [4, 7], "area": 4, "kwarg": 4, "keyword": 4, "argument": 4, "assign_correct_typ": 4, "assign": 4, "correct": 4, "column": 4, "wert": 4, "parse_cub": 4, "same": 4, "qei": 4, "each": [4, 5, 7], "header": [4, 7], "kei": 4, "correspond": 4, "block": 4, "rename_ax": 4, "rename_classifying_vari": 4, "rename_time_vari": 4, "renam": 4, "gener": 4, "ax": 4, "found": 4, "classifi": 4, "implement": [4, 5], "retriev": [4, 5, 7], "db_name": 4, "top_n_preview": 4, "5": 4, "repres": 4, "includ": 4, "statist": [4, 7], "int": 4, "regio": 4, "summari": 4, "string": 4, "contain": [4, 5, 7], "summary_str": 4, "categori": 4, "df": [4, 7], "plural": 4, "e": [4, 7], "g": [4, 7], "get_cod": [4, 7], "row_numb": 4, "get_metadata": [4, 7], "row": 4, "meta": 4, "rest": 4, "construct": 4, "url": 4, "login": [4, 6], "respons": 4, "host": [4, 7], "ip": 4, "address": 4, "get_data_from_endpoint": 4, "send": 4, "eg": 4, "catalogu": 4, "tablefil": 4, "get_data_from_resultfil": 4, "job_id": 4, "onc": [4, 5, 6], "finish": 4, "timeout": 4, "reach": 4, "get_job_id_from_respons": 4, "successfulli": 4, "equal": 4, "load_data": 4, "as_json": 4, "fals": 4, "previou": 4, "valid": 4, "json": 4, "union": 4, "start_job": 4, "small": 4, "helper": 4, "change_password": 4, "new_password": 4, "password": [4, 6], "updat": [4, 5], "local": [4, 7], "remove_result": 4, "ergebnistabellen": 4, "permiss": 4, "space": 4, "onli": [4, 6, 7], "appli": 4, "save": 4, "visibl": 4, "mein": 4, "tabellen": 4, "ergebnistabel": 4, "resid": 4, "busi": 4, "logic": [4, 7], "relat": 4, "prettifi": 4, "reformat": 4, "readabl": 4, "format": [4, 5], "static": 4, "parse_genesis_t": 4, "parse_regio_t": 4, "parse_zensus_t": 4, "prettify_t": 4, "db": 4, "unnecessari": 4, "basic": 4, "pstat": 4, "few": 5, "idea": 5, "mayb": 5, "futur": 5, "improv": 5, "tabl": [5, 7], "now": [5, 7], "realli": 5, "simpl": 5, "align": [5, 7], "conveni": 5, "mechan": 5, "newer": 5, "than": 5, "matter": 5, "howev": 5, "could": 5, "quit": 5, "challeng": 5, "bad": 5, "good": 5, "consist": [5, 7], "field": 5, "last": 5, "datetim": 5, "look": 5, "understand": 5, "seri": 5, "regist": 6, "usernam": 6, "authent": 6, "one": 6, "simpli": 6, "guid": 6, "how": [6, 7], "desir": 6, "For": [6, 7], "studi": [6, 7], "sampl": [6, 7], "notebook": [6, 7], "multipl": 7, "element": 7, "summar": 7, "imag": 7, "multi": 7, "dimension": 7, "deriv": 7, "unit": 7, "offer": 7, "piec": 7, "behind": 7, "scene": 7, "exampl": 7, "roh\u00f6l": 7, "initi": 7, "1": 7, "2": 7, "overview": 7, "case": 7, "form": 7, "both": 7, "been": 7, "close": 7, "t": 7, "21311": 7, "0001": 7, "yet": 7, "fetch": 7, "next": 7, "22922kj1141": 7, "put": 7, "automat": 7, "dev": 7, "github": 7, "built": 7, "cd": 7, "doc": 7, "html": 7, "besid": 7, "docstr": 7, "individu": 7, "modul": 7, "mirror": 7, "most": 7, "readm": 7, "crucial": 7, "reli": 7, "section": 7, "care": 7, "sphinx": 7}, "objects": {"": [[4, 0, 0, "-", "pystatis"]], "pystatis": [[4, 1, 1, "", "Cube"], [4, 1, 1, "", "Find"], [4, 1, 1, "", "Table"], [4, 0, 0, "-", "cache"], [4, 4, 1, "", "clear_cache"], [4, 0, 0, "-", "config"], [4, 0, 0, "-", "cube"], [4, 0, 0, "-", "find"], [4, 0, 0, "-", "helloworld"], [4, 0, 0, "-", "http_helper"], [4, 4, 1, "", "logincheck"], [4, 0, 0, "-", "profile"], [4, 4, 1, "", "setup_credentials"], [4, 0, 0, "-", "table"], [4, 4, 1, "", "whoami"]], "pystatis.Cube": [[4, 2, 1, "", "get_data"]], "pystatis.Find": [[4, 3, 1, "", "cubes"], [4, 3, 1, "", "db_name"], [4, 3, 1, "", "query"], [4, 2, 1, "id4", "run"], [4, 3, 1, "", "statistics"], [4, 2, 1, "id5", "summary"], [4, 3, 1, "", "tables"], [4, 3, 1, "", "variables"]], "pystatis.Table": [[4, 2, 1, "", "get_data"], [4, 2, 1, "", "parse_genesis_table"], [4, 2, 1, "", "parse_regio_table"], [4, 2, 1, "", "parse_zensus_table"], [4, 2, 1, "", "prettify_table"]], "pystatis.cache": [[4, 4, 1, "", "cache_data"], [4, 4, 1, "", "clear_cache"], [4, 4, 1, "", "hit_in_cash"], [4, 4, 1, "", "normalize_name"], [4, 4, 1, "", "read_from_cache"]], "pystatis.config": [[4, 4, 1, "", "config_exists"], [4, 4, 1, "", "create_default_config"], [4, 4, 1, "", "delete_config"], [4, 4, 1, "", "get_cache_dir"], [4, 4, 1, "", "get_db_identifiers"], [4, 4, 1, "", "get_supported_db"], [4, 4, 1, "", "init_config"], [4, 4, 1, "", "load_config"], [4, 4, 1, "", "setup_credentials"], [4, 4, 1, "", "write_config"]], "pystatis.cube": [[4, 1, 1, "", "Cube"], [4, 4, 1, "", "assign_correct_types"], [4, 4, 1, "", "parse_cube"], [4, 4, 1, "", "rename_axes"]], "pystatis.cube.Cube": [[4, 2, 1, "", "get_data"]], "pystatis.find": [[4, 1, 1, "", "Find"], [4, 1, 1, "", "Results"]], "pystatis.find.Find": [[4, 3, 1, "", "cubes"], [4, 3, 1, "", "db_name"], [4, 3, 1, "", "query"], [4, 2, 1, "id0", "run"], [4, 3, 1, "", "statistics"], [4, 2, 1, "id1", "summary"], [4, 3, 1, "", "tables"], [4, 3, 1, "", "variables"]], "pystatis.find.Results": [[4, 3, 1, "", "category"], [4, 3, 1, "", "db_name"], [4, 3, 1, "", "df"], [4, 2, 1, "id2", "get_code"], [4, 2, 1, "id3", "get_metadata"]], "pystatis.helloworld": [[4, 4, 1, "", "logincheck"], [4, 4, 1, "", "whoami"]], "pystatis.http_helper": [[4, 4, 1, "", "get_data_from_endpoint"], [4, 4, 1, "", "get_data_from_resultfile"], [4, 4, 1, "", "get_job_id_from_response"], [4, 4, 1, "", "load_data"], [4, 4, 1, "", "start_job"]], "pystatis.profile": [[4, 4, 1, "", "change_password"], [4, 4, 1, "", "remove_result"]], "pystatis.table": [[4, 1, 1, "", "Table"]], "pystatis.table.Table": [[4, 2, 1, "", "get_data"], [4, 2, 1, "", "parse_genesis_table"], [4, 2, 1, "", "parse_regio_table"], [4, 2, 1, "", "parse_zensus_table"], [4, 2, 1, "", "prettify_table"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "function", "Python function"]}, "titleterms": {"develop": 0, "inform": 0, "contributor": 0, "dev": 0, "env": 0, "setup": 0, "workflow": 0, "pystati": [1, 4], "content": [1, 4], "modul": [1, 4], "indic": 1, "tabl": [1, 4], "instal": 2, "licens": 3, "packag": 4, "cach": [4, 7], "config": 4, "cube": 4, "custom_except": 4, "find": [4, 7], "helloworld": 4, "http_helper": 4, "profil": 4, "overal": 4, "roadmap": 5, "get": 6, "start": 6, "usag": 7, "The": 7, "genesi": 7, "data": 7, "model": 7, "right": 7, "download": 7, "clear": 7, "full": 7, "document": 7}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Developer Information": [[0, "developer-information"]], "Contributor information": [[0, "contributor-information"]], "Dev env setup": [[0, "dev-env-setup"]], "Workflow": [[0, "workflow"]], "pystatis": [[1, "pystatis"]], "Contents": [[1, null]], "Modules": [[1, null]], "Indices and tables": [[1, "indices-and-tables"]], "Installation": [[2, "installation"]], "License": [[3, "license"]], "pystatis package": [[4, "pystatis-package"]], "pystatis.cache module": [[4, "module-pystatis.cache"]], "pystatis.config module": [[4, "module-pystatis.config"]], "pystatis.cube module": [[4, "module-pystatis.cube"]], "pystatis.custom_exceptions module": [[4, "pystatis-custom-exceptions-module"]], "pystatis.find module": [[4, "module-pystatis.find"]], "pystatis.helloworld module": [[4, "module-pystatis.helloworld"]], "pystatis.http_helper module": [[4, "module-pystatis.http_helper"]], "pystatis.profile module": [[4, "module-pystatis.profile"]], "pystatis.table module": [[4, "module-pystatis.table"]], "Overall Module contents": [[4, "module-pystatis"]], "Roadmap": [[5, "roadmap"]], "Getting started": [[6, "getting-started"]], "Usage": [[7, "usage"]], "The GENESIS data model": [[7, "the-genesis-data-model"]], "Find the right data": [[7, "find-the-right-data"]], "Download data": [[7, "download-data"]], "Clear Cache": [[7, "clear-cache"]], "Full documentation": [[7, "full-documentation"]]}, "indexentries": {"cube (class in pystatis)": [[4, "pystatis.Cube"]], "cube (class in pystatis.cube)": [[4, "pystatis.cube.Cube"]], "find (class in pystatis)": [[4, "pystatis.Find"]], "find (class in pystatis.find)": [[4, "pystatis.find.Find"]], "results (class in pystatis.find)": [[4, "pystatis.find.Results"]], "table (class in pystatis)": [[4, "pystatis.Table"]], "table (class in pystatis.table)": [[4, "pystatis.table.Table"]], "assign_correct_types() (in module pystatis.cube)": [[4, "pystatis.cube.assign_correct_types"]], "cache_data() (in module pystatis.cache)": [[4, "pystatis.cache.cache_data"]], "category (pystatis.find.results attribute)": [[4, "pystatis.find.Results.category"]], "change_password() (in module pystatis.profile)": [[4, "pystatis.profile.change_password"]], "clear_cache() (in module pystatis)": [[4, "pystatis.clear_cache"]], "clear_cache() (in module pystatis.cache)": [[4, "pystatis.cache.clear_cache"]], "config_exists() (in module pystatis.config)": [[4, "pystatis.config.config_exists"]], "create_default_config() (in module pystatis.config)": [[4, "pystatis.config.create_default_config"]], "cubes (pystatis.find attribute)": [[4, "pystatis.Find.cubes"]], "cubes (pystatis.find.find attribute)": [[4, "pystatis.find.Find.cubes"]], "db_name (pystatis.find attribute)": [[4, "pystatis.Find.db_name"]], "db_name (pystatis.find.find attribute)": [[4, "pystatis.find.Find.db_name"]], "db_name (pystatis.find.results attribute)": [[4, "pystatis.find.Results.db_name"]], "delete_config() (in module pystatis.config)": [[4, "pystatis.config.delete_config"]], "df (pystatis.find.results attribute)": [[4, "pystatis.find.Results.df"]], "get_cache_dir() (in module pystatis.config)": [[4, "pystatis.config.get_cache_dir"]], "get_code() (pystatis.find.results method)": [[4, "id2"], [4, "pystatis.find.Results.get_code"]], "get_data() (pystatis.cube method)": [[4, "pystatis.Cube.get_data"]], "get_data() (pystatis.table method)": [[4, "pystatis.Table.get_data"]], "get_data() (pystatis.cube.cube method)": [[4, "pystatis.cube.Cube.get_data"]], "get_data() (pystatis.table.table method)": [[4, "pystatis.table.Table.get_data"]], "get_data_from_endpoint() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.get_data_from_endpoint"]], "get_data_from_resultfile() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.get_data_from_resultfile"]], "get_db_identifiers() (in module pystatis.config)": [[4, "pystatis.config.get_db_identifiers"]], "get_job_id_from_response() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.get_job_id_from_response"]], "get_metadata() (pystatis.find.results method)": [[4, "id3"], [4, "pystatis.find.Results.get_metadata"]], "get_supported_db() (in module pystatis.config)": [[4, "pystatis.config.get_supported_db"]], "hit_in_cash() (in module pystatis.cache)": [[4, "pystatis.cache.hit_in_cash"]], "init_config() (in module pystatis.config)": [[4, "pystatis.config.init_config"]], "load_config() (in module pystatis.config)": [[4, "pystatis.config.load_config"]], "load_data() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.load_data"]], "logincheck() (in module pystatis)": [[4, "pystatis.logincheck"]], "logincheck() (in module pystatis.helloworld)": [[4, "pystatis.helloworld.logincheck"]], "module": [[4, "module-pystatis"], [4, "module-pystatis.cache"], [4, "module-pystatis.config"], [4, "module-pystatis.cube"], [4, "module-pystatis.find"], [4, "module-pystatis.helloworld"], [4, "module-pystatis.http_helper"], [4, "module-pystatis.profile"], [4, "module-pystatis.table"]], "normalize_name() (in module pystatis.cache)": [[4, "pystatis.cache.normalize_name"]], "parse_cube() (in module pystatis.cube)": [[4, "pystatis.cube.parse_cube"]], "parse_genesis_table() (pystatis.table static method)": [[4, "pystatis.Table.parse_genesis_table"]], "parse_genesis_table() (pystatis.table.table static method)": [[4, "pystatis.table.Table.parse_genesis_table"]], "parse_regio_table() (pystatis.table static method)": [[4, "pystatis.Table.parse_regio_table"]], "parse_regio_table() (pystatis.table.table static method)": [[4, "pystatis.table.Table.parse_regio_table"]], "parse_zensus_table() (pystatis.table static method)": [[4, "pystatis.Table.parse_zensus_table"]], "parse_zensus_table() (pystatis.table.table static method)": [[4, "pystatis.table.Table.parse_zensus_table"]], "prettify_table() (pystatis.table static method)": [[4, "pystatis.Table.prettify_table"]], "prettify_table() (pystatis.table.table static method)": [[4, "pystatis.table.Table.prettify_table"]], "pystatis": [[4, "module-pystatis"]], "pystatis.cache": [[4, "module-pystatis.cache"]], "pystatis.config": [[4, "module-pystatis.config"]], "pystatis.cube": [[4, "module-pystatis.cube"]], "pystatis.find": [[4, "module-pystatis.find"]], "pystatis.helloworld": [[4, "module-pystatis.helloworld"]], "pystatis.http_helper": [[4, "module-pystatis.http_helper"]], "pystatis.profile": [[4, "module-pystatis.profile"]], "pystatis.table": [[4, "module-pystatis.table"]], "query (pystatis.find attribute)": [[4, "pystatis.Find.query"]], "query (pystatis.find.find attribute)": [[4, "pystatis.find.Find.query"]], "read_from_cache() (in module pystatis.cache)": [[4, "pystatis.cache.read_from_cache"]], "remove_result() (in module pystatis.profile)": [[4, "pystatis.profile.remove_result"]], "rename_axes() (in module pystatis.cube)": [[4, "pystatis.cube.rename_axes"]], "run() (pystatis.find method)": [[4, "id4"], [4, "pystatis.Find.run"]], "run() (pystatis.find.find method)": [[4, "id0"], [4, "pystatis.find.Find.run"]], "setup_credentials() (in module pystatis)": [[4, "pystatis.setup_credentials"]], "setup_credentials() (in module pystatis.config)": [[4, "pystatis.config.setup_credentials"]], "start_job() (in module pystatis.http_helper)": [[4, "pystatis.http_helper.start_job"]], "statistics (pystatis.find attribute)": [[4, "pystatis.Find.statistics"]], "statistics (pystatis.find.find attribute)": [[4, "pystatis.find.Find.statistics"]], "summary() (pystatis.find method)": [[4, "id5"], [4, "pystatis.Find.summary"]], "summary() (pystatis.find.find method)": [[4, "id1"], [4, "pystatis.find.Find.summary"]], "tables (pystatis.find attribute)": [[4, "pystatis.Find.tables"]], "tables (pystatis.find.find attribute)": [[4, "pystatis.find.Find.tables"]], "variables (pystatis.find attribute)": [[4, "pystatis.Find.variables"]], "variables (pystatis.find.find attribute)": [[4, "pystatis.find.Find.variables"]], "whoami() (in module pystatis)": [[4, "pystatis.whoami"]], "whoami() (in module pystatis.helloworld)": [[4, "pystatis.helloworld.whoami"]], "write_config() (in module pystatis.config)": [[4, "pystatis.config.write_config"]]}}) \ No newline at end of file diff --git a/dev/start.html b/dev/start.html index e85c921..c9f3845 100644 --- a/dev/start.html +++ b/dev/start.html @@ -59,7 +59,7 @@

    Modules

    diff --git a/dev/use.html b/dev/use.html index 499645f..477701b 100644 --- a/dev/use.html +++ b/dev/use.html @@ -66,7 +66,7 @@

    Modules