gooddata-pandas 1.53.0__tar.gz → 1.53.1.dev1__tar.gz

gooddata_pandas-1.53.1.dev1/.gitignore

@@ -0,0 +1,67 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+venv/
+.venv/
+.python-version
+.pytest_cache
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+docs/_autosummary/
+
+# PyBuilder
+target/
+
+#Ipython Notebook
+.ipynb_checkpoints

gooddata_pandas-1.53.1.dev1/.readthedocs.yaml

@@ -0,0 +1,19 @@
+# (C) 2023 GoodData Corporation
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.13"
+
+sphinx:
+  configuration: gooddata-pandas/docs/conf.py
+
+python:
+  install:
+    - requirements: gooddata-pandas/docs/requirements.txt

gooddata_pandas-1.53.1.dev1/Makefile

@@ -0,0 +1,6 @@
+# (C) 2021 GoodData Corporation
+include ../../project_common.mk
+
+.PHONY: docs
+docs:
+	tox $(TOX_FLAGS) -e docs

{gooddata_pandas-1.53.0/gooddata_pandas.egg-info → gooddata_pandas-1.53.1.dev1}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: gooddata-pandas
-Version: 1.53.0
+Version: 1.53.1.dev1
 Summary: GoodData Cloud to pandas
-Author: GoodData
-Author-email: support@gooddata.com
-License: MIT
-Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.53.0
+Project-URL: Documentation, https://gooddata-pandas.readthedocs.io/en/v1.53.1.dev1
 Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
-Keywords: gooddata,pandas,series,data,frame,data_frame,analytics,headless,business,intelligence,headless-bi,cloud,native,semantic,layer,sql,metrics
+Author-email: GoodData <support@gooddata.com>
+License: MIT
+License-File: LICENSE.txt
+Keywords: analytics,business,cloud,data,data_frame,frame,gooddata,headless,headless-bi,intelligence,layer,metrics,native,pandas,semantic,series,sql
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: License :: OSI Approved :: MIT License
@@ -21,22 +21,9 @@ Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development
 Classifier: Typing :: Typed
 Requires-Python: >=3.9.0
-Description-Content-Type: text/markdown
-License-File: LICENSE.txt
-Requires-Dist: gooddata-sdk~=1.53.0
+Requires-Dist: gooddata-sdk~=1.53.1.dev1
 Requires-Dist: pandas<3.0.0,>=2.0.0
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
+Description-Content-Type: text/markdown
 
 # GoodData Pandas
 

gooddata_pandas-1.53.1.dev1/docs/_static/empty_file

@@ -0,0 +1 @@
+# (C) 2022 GoodData Corporation

gooddata_pandas-1.53.1.dev1/docs/_templates/class-template.rst

@@ -0,0 +1,32 @@
+{{ fullname | escape | underline}}
+
+.. currentmodule:: {{ module }}
+
+.. autoclass:: {{ objname }}
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+   {% block methods %}
+   .. automethod:: __init__
+
+   {% if methods %}
+   .. rubric:: {{ _('Methods') }}
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: {{ _('Attributes') }}
+
+   .. autosummary::
+   {% for item in attributes %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}

gooddata_pandas-1.53.1.dev1/docs/_templates/module-template.rst

@@ -0,0 +1,66 @@
+{{ fullname | escape | underline}}
+
+.. automodule:: {{ fullname }}
+
+   {% block attributes %}
+   {% if attributes %}
+   .. rubric:: Module Attributes
+
+   .. autosummary::
+      :toctree:
+   {% for item in attributes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block functions %}
+   {% if functions %}
+   .. rubric:: {{ _('Functions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in functions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block classes %}
+   {% if classes %}
+   .. rubric:: {{ _('Classes') }}
+
+   .. autosummary::
+      :toctree:
+      :template: class-template.rst
+   {% for item in classes %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+   {% block exceptions %}
+   {% if exceptions %}
+   .. rubric:: {{ _('Exceptions') }}
+
+   .. autosummary::
+      :toctree:
+   {% for item in exceptions %}
+      {{ item }}
+   {%- endfor %}
+   {% endif %}
+   {% endblock %}
+
+{% block modules %}
+{% if modules %}
+.. rubric:: Modules
+
+.. autosummary::
+   :toctree:
+   :template: module-template.rst
+   :recursive:
+{% for item in modules %}
+   {{ item }}
+{%- endfor %}
+{% endif %}
+{% endblock %}

gooddata_pandas-1.53.1.dev1/docs/api.rst

@@ -0,0 +1,9 @@
+API
+===
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: module-template.rst
+   :recursive:
+
+   gooddata_pandas

gooddata_pandas-1.53.1.dev1/docs/conf.py

@@ -0,0 +1,70 @@
+# (C) 2022 GoodData Corporation
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+import gooddata_pandas
+
+sys.path.insert(0, os.path.abspath(".."))
+print(f"sys.path = {sys.path}")
+print(f"os.getcwd() = {os.getcwd()}")
+
+project = "GoodData Pandas"
+copyright = "2021-2022, GoodData Corporation"
+author = "GoodData Corporation"
+
+# The full version, including alpha/beta/rc tags
+release = gooddata_pandas.__version__
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "pallets_sphinx_themes",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+source_suffix = {
+    ".rst": "restructuredtext",
+}
+
+# intersphinx_mapping = {
+#     "gooddata_sdk": ("", None)
+# }

gooddata_pandas-1.53.1.dev1/docs/examples.rst

@@ -0,0 +1,111 @@
+
+Examples
+********
+
+Here are a couple of introductory examples how to create indexed and not-indexed series and data frames:
+
+Series
+======
+
+.. code-block:: python
+
+    from gooddata_pandas import GoodPandas
+
+    # GoodData.CN host in the form of uri eg. "http://localhost:3000"
+    host = "http://localhost:3000"
+    # GoodData.CN user token
+    token = "some_user_token"
+    # initialize the adapter to work on top of GD.CN host and use the provided authentication token
+    gp = GoodPandas(host, token)
+
+    workspace_id = "demo"
+    series = gp.series(workspace_id)
+
+    # create indexed series
+    indexed_series = series.indexed(index_by="label/label_id", data_by="fact/measure_id")
+
+    # create non-indexed series containing just the values of measure sliced by elements of the label
+    non_indexed = series.not_indexed(data_by="fact/measure_id", granularity="label/label_id")
+
+Data Frames
+===========
+
+.. code-block:: python
+
+    from gooddata_pandas import GoodPandas
+
+    # GoodData.CN host in the form of uri eg. "http://localhost:3000"
+    host = "http://localhost:3000"
+    # GoodData.CN user token
+    token = "some_user_token"
+    # initialize the adapter to work on top of GD.CN host and use the provided authentication token
+    gp = GoodPandas(host, token)
+
+    workspace_id = "demo"
+    frames = gp.data_frames(workspace_id)
+
+    # create indexed data frame
+    indexed_df = frames.indexed(
+        index_by="label/label_id",
+        columns=dict(
+            first_label='label/first_label_id',
+            second_label='label/second_label_id',
+            first_metric='metric/first_metric_id',
+            second_metric='fact/fact_id'
+        )
+    )
+
+    # create data frame with hierarchical index
+    indexed_df = frames.indexed(
+        index_by=dict(first_label='label/first_label_id', second_label='label/second_label_id'),
+        columns=dict(first_metric='metric/first_metric_id', second_metric='fact/fact_id')
+    )
+
+    # create non-indexed data frame
+    non_indexed_df = frames.not_indexed(
+        columns=dict(
+            first_label='label/first_label_id',
+            second_label='label/second_label_id',
+            first_metric='metric/first_metric_id',
+            second_metric='fact/fact_id'
+        )
+    )
+
+    # create data frame based on the contents of the visualization. if the visualization contains labels and
+    #  measures, the data frame will contain index or hierarchical index.
+    visualization_df = frames.for_visualization('visualization_id')
+
+    # create data frame based on the content of the items dict. if the dict contains both labels
+    # and measures, the frame will contain index or hierarchical index.
+    df = frames.for_items(
+        items=dict(
+            first_label='label/first_label_id',
+            second_label='label/second_label_id',
+            first_metric='metric/first_metric_id',
+            second_metric='fact/fact_id'
+        )
+    )
+
+    # create data frame from custom execution definition
+    exec_def = ExecutionDefinition(
+        attributes=[
+            Attribute(local_id="region", label="region"),
+            Attribute(local_id="state", label="state"),
+            Attribute(local_id="product_category", label="products.category"),
+        ],
+        metrics=[
+            SimpleMetric(local_id="price", item=ObjId(id="price", type="fact")),
+            SimpleMetric(local_id="order_amount", item=ObjId(id="order_amount", type="metric")),
+        ],
+        filters=[],
+        dimensions=[
+            TableDimension(item_ids=["state", "region"]),
+            TableDimension(item_ids=["product_category", "measureGroup"]),
+        ],
+    )
+    df, df_metadata = frames.for_exec_def(exec_def=exec_def)
+
+    # use result ID from computation above and generate dataframe just from it
+    df_from_result_id, df_metadata_from_result_id = frames.for_exec_result_id(
+        result_id=df_metadata.execution_response.result_id,
+    )

gooddata_pandas-1.53.1.dev1/docs/index.rst

@@ -0,0 +1,13 @@
+GoodData Pandas Documentation
+*****************************
+
+GoodData Pandas contains a thin layer that utilizes GoodData Python SDK and allows you to conveniently create pandas series and
+data frames from the computations done against semantic model in your GoodData.CN workspace.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   installation
+   examples
+   api

gooddata_pandas-1.53.1.dev1/docs/installation.rst

@@ -0,0 +1,17 @@
+Installation
+************
+
+Requirements
+=============
+
+- Python 3.7 or newer
+- GoodData.CN or GoodData Cloud
+
+Installation
+============
+
+Run the following command to install the ``gooddata-pandas`` package on your system:
+
+.. code-block:: shell
+
+    pip install gooddata-pandas

gooddata_pandas-1.53.1.dev1/docs/requirements.txt

@@ -0,0 +1,7 @@
+Sphinx~=5.1.1
+pallets-sphinx-themes
+sphinx-rtd-theme
+# Dependencies to the other projects in the repository
+-e ../gooddata-api-client
+-e ../gooddata-sdk
+-e ../gooddata-pandas

gooddata_pandas-1.53.1.dev1/mypy.ini

@@ -0,0 +1,17 @@
+# (C) 2021 GoodData Corporation
+[mypy]
+plugins = pydantic.mypy
+disallow_untyped_defs = True
+warn_redundant_casts = True
+strict_equality = True
+no_implicit_optional = True
+python_version = 3.9
+
+[mypy-gooddata_api_client.*]
+ignore_missing_imports = True
+
+[mypy-gooddata_sdk.*]
+ignore_missing_imports = True
+
+[mypy-pandas.*]
+ignore_missing_imports = True

gooddata_pandas-1.53.1.dev1/pyproject.toml

@@ -0,0 +1,79 @@
+# (C) 2025 GoodData Corporation
+[project]
+name = "gooddata-pandas"
+version = "1.53.1.dev1"
+description = "GoodData Cloud to pandas"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [
+    {name = "GoodData", email = "support@gooddata.com"}
+]
+keywords = [
+    "gooddata",
+    "pandas",
+    "series",
+    "data",
+    "frame",
+    "data_frame",
+    "analytics",
+    "headless",
+    "business",
+    "intelligence",
+    "headless-bi",
+    "cloud",
+    "native",
+    "semantic",
+    "layer",
+    "sql",
+    "metrics",
+]
+requires-python = ">=3.9.0"
+dependencies = [
+    "gooddata-sdk~=1.53.1.dev1",
+    "pandas>=2.0.0,<3.0.0",
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Database",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development",
+    "Typing :: Typed",
+]
+
+[tool.uv.sources]
+gooddata-sdk = { workspace = true }
+
+[project.urls]
+Documentation = "https://gooddata-pandas.readthedocs.io/en/v1.53.1.dev1"
+Source = "https://github.com/gooddata/gooddata-python-sdk"
+
+[dependency-groups]
+test = [
+    "pytest~=8.3.4",
+    "pytest-cov~=6.0.0",
+    "pytest-snapshot==0.9.0",
+    "pytest-order~=1.3.0",
+    "vcrpy~=7.0.0",
+    "urllib3==1.26.9",
+    "python-dotenv~=1.0.0",
+    "pyyaml"
+]
+type = [
+    "mypy~=1.11.2",
+    "pydantic~=2.9.2"
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/gooddata_pandas"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

gooddata_pandas-1.53.1.dev1/tests/__init__.py

@@ -0,0 +1,51 @@
+# (C) 2021 GoodData Corporation
+from __future__ import annotations
+
+from dotenv import dotenv_values, find_dotenv
+
+
+def _load_test_env():
+    try:
+        test_env = find_dotenv(".env.test", raise_error_if_not_found=True)
+
+        return dotenv_values(test_env)
+    except OSError:
+        return dict()
+
+
+def get_test_token():
+    config = _load_test_env()
+
+    if "TEST_TOKEN" not in config:
+        # returning bogus token so that tests that use vcr recordings have something to use
+        return "test-token-undefined"
+
+    return config["TEST_TOKEN"]
+
+
+TEST_DATA_REGIONS = [
+    "Aargau",
+    "Basel-Landschaft",
+    "Basel-Stadt",
+    "Bern",
+    "Fribourg",
+    "Geneva",
+    "Glarus",
+    "Graubünden",
+    "Jura",
+    "Lucerne",
+    "Neuchâtel",
+    "Nidwalden",
+    "Obwalden",
+    "Schaffhausen",
+    "Schwyz",
+    "Solothurn",
+    "St. Gallen",
+    "Thurgau",
+    "Ticino",
+    "Uri",
+    "Valais",
+    "Vaud",
+    "Zug",
+    "Zürich",
+]

gooddata_pandas-1.53.1.dev1/tests/conftest.py

@@ -0,0 +1,24 @@
+# (C) 2021 GoodData Corporation
+from pathlib import Path
+
+import pytest
+import yaml
+
+
+def pytest_addoption(parser):
+    default_config_path = Path(__file__).parent / "gd_test_config.yaml"
+    parser.addoption(
+        "--gd-test-config",
+        action="store",
+        default=str(default_config_path),
+        help="Absolut path to test configuration",
+    )
+
+
+@pytest.fixture(scope="session")
+def test_config(request):
+    config_path = Path(request.config.getoption("--gd-test-config"))
+    with open(config_path) as f:
+        config = yaml.safe_load(f)
+
+    return config

gooddata_pandas-1.53.1.dev1/tests/dataframe/__init__.py

@@ -0,0 +1 @@
+# (C) 2021 GoodData Corporation

gooddata_pandas-1.53.1.dev1/tests/dataframe/conftest.py

@@ -0,0 +1,9 @@
+# (C) 2021 GoodData Corporation
+import pytest
+from gooddata_pandas import DataFrameFactory, GoodPandas
+
+
+@pytest.fixture
+def gdf(test_config) -> DataFrameFactory:
+    gdpd = GoodPandas(host=test_config["host"], token=test_config["token"])
+    return gdpd.data_frames(test_config["workspace"])