jampp-reporting-api-client 0.3.0__tar.gz → 0.3.2__tar.gz

{jampp_reporting_api_client-0.3.0 → jampp_reporting_api_client-0.3.2}/CHANGELOG.rst

@@ -15,6 +15,20 @@ When major components get significant changes worthy of mention, they
 can be described in a Major section.
 
 
+v0.3.2 - 2026-06-01
+===================
+
+Changed
+-------
+
+- Relax gql requirements to improve compatibility with older stacks
+
+
+v0.3.1 - 2026-04-29
+===================
+
+Yanked
+
 v0.3.0 - 2022-09-12
 ===================
 

jampp_reporting_api_client-0.3.2/MANIFEST.in

@@ -0,0 +1,4 @@
+include CHANGELOG.rst
+include README.rst
+include requirements.in
+include requirements-dev.in

jampp_reporting_api_client-0.3.2/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: jampp_reporting_api_client
+Version: 0.3.2
+Summary: Client for Reporting API.
+Home-page: https://github.com/jampp/reporting-api-client
+Author: Jampp
+Author-email: data-infra@jampp.com
+Description-Content-Type: text/x-rst
+Requires-Dist: gql>=3.0.0
+Requires-Dist: requests<3
+Requires-Dist: requests_toolbelt<2,>=1.0.0
+Requires-Dist: requests_oauthlib
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: pre-commit>2.9.2; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: pandas
+Requires-Dist: pandas; extra == "pandas"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+====================
+Reporting API Client
+====================
+
+This is a Python Client for `Jampp's Reporting API`_. For more information, check the `docs`_.
+
+Features
+========
+
+* Execute Pivots in an user friendly manner.
+* Execute raw GraphQL queries against the Reporting API.
+
+
+Basic Usage
+===========
+
+.. code-block:: python
+
+    import os
+
+    from reporting_api_client import ReportingAPIClient
+
+
+    client = ReportingAPIClient(os.environ["CLIENT_ID"], os.environ["CLIENT_SECRET"])
+    query = """{
+        pivot(from: "2022-07-01", to: "2022-07-02", granularity: DAILY) {
+            results {
+                clicks
+            }
+        }
+    }"""
+
+    result = client.query(query)
+    print(result)
+
+
+Executing the above code should output a result similar to the following:
+
+  .. code-block:: console
+
+      $ python example.py
+      {'pivot': {'results': [{'clicks': 123456}]}}
+
+.. _`Jampp's Reporting API`: https://developers.jampp.com/docs/reporting-api/
+.. _docs: https://developers.jampp.com/docs/reporting-api-client/
+
+
+.. _changelog:
+
+==========
+Change Log
+==========
+
+All notable changes to this project will be documented here.
+
+Sort subsections like so: Added, Bugfixes, Improvements, Technical tasks.
+Group anything an end user shouldn't care deeply about into technical
+tasks, even if they're technically bugs. Only include as "bugfixes"
+bugs with user-visible outcomes.
+
+When major components get significant changes worthy of mention, they
+can be described in a Major section.
+
+
+v0.3.2 - 2026-06-01
+===================
+
+Changed
+-------
+
+- Relax gql requirements to improve compatibility with older stacks
+
+
+v0.3.1 - 2026-04-29
+===================
+
+Yanked
+
+v0.3.0 - 2022-09-12
+===================
+
+Added
+-----
+
+- Add workflows for CI and publishing to PyPI.
+- Host documentation publically.
+
+Changed
+-------
+
+- Remove Jampp's refferences.
+
+
+v0.2.0 - 2022-08-29
+===================
+
+Added
+-----
+
+- Remove need of introspection on client.
+
+
+v0.1.0 - 2022-07-19
+===================
+
+Added
+-----
+
+- Add base ``ReportingAPIClient`` implementation using OAuth for authentication
+- Rename to ``reporting_api_client``.

{jampp_reporting_api_client-0.3.0 → jampp_reporting_api_client-0.3.2}/README.rst

@@ -2,7 +2,7 @@
 Reporting API Client
 ====================
 
-This is a Python Client for `Jampp's Reporting API`_. For more information, check the `docs`.
+This is a Python Client for `Jampp's Reporting API`_. For more information, check the `docs`_.
 
 Features
 ========

jampp_reporting_api_client-0.3.2/jampp_reporting_api_client.egg-info/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: jampp_reporting_api_client
+Version: 0.3.2
+Summary: Client for Reporting API.
+Home-page: https://github.com/jampp/reporting-api-client
+Author: Jampp
+Author-email: data-infra@jampp.com
+Description-Content-Type: text/x-rst
+Requires-Dist: gql>=3.0.0
+Requires-Dist: requests<3
+Requires-Dist: requests_toolbelt<2,>=1.0.0
+Requires-Dist: requests_oauthlib
+Provides-Extra: dev
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: pre-commit>2.9.2; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: pandas
+Requires-Dist: pandas; extra == "pandas"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+====================
+Reporting API Client
+====================
+
+This is a Python Client for `Jampp's Reporting API`_. For more information, check the `docs`_.
+
+Features
+========
+
+* Execute Pivots in an user friendly manner.
+* Execute raw GraphQL queries against the Reporting API.
+
+
+Basic Usage
+===========
+
+.. code-block:: python
+
+    import os
+
+    from reporting_api_client import ReportingAPIClient
+
+
+    client = ReportingAPIClient(os.environ["CLIENT_ID"], os.environ["CLIENT_SECRET"])
+    query = """{
+        pivot(from: "2022-07-01", to: "2022-07-02", granularity: DAILY) {
+            results {
+                clicks
+            }
+        }
+    }"""
+
+    result = client.query(query)
+    print(result)
+
+
+Executing the above code should output a result similar to the following:
+
+  .. code-block:: console
+
+      $ python example.py
+      {'pivot': {'results': [{'clicks': 123456}]}}
+
+.. _`Jampp's Reporting API`: https://developers.jampp.com/docs/reporting-api/
+.. _docs: https://developers.jampp.com/docs/reporting-api-client/
+
+
+.. _changelog:
+
+==========
+Change Log
+==========
+
+All notable changes to this project will be documented here.
+
+Sort subsections like so: Added, Bugfixes, Improvements, Technical tasks.
+Group anything an end user shouldn't care deeply about into technical
+tasks, even if they're technically bugs. Only include as "bugfixes"
+bugs with user-visible outcomes.
+
+When major components get significant changes worthy of mention, they
+can be described in a Major section.
+
+
+v0.3.2 - 2026-06-01
+===================
+
+Changed
+-------
+
+- Relax gql requirements to improve compatibility with older stacks
+
+
+v0.3.1 - 2026-04-29
+===================
+
+Yanked
+
+v0.3.0 - 2022-09-12
+===================
+
+Added
+-----
+
+- Add workflows for CI and publishing to PyPI.
+- Host documentation publically.
+
+Changed
+-------
+
+- Remove Jampp's refferences.
+
+
+v0.2.0 - 2022-08-29
+===================
+
+Added
+-----
+
+- Remove need of introspection on client.
+
+
+v0.1.0 - 2022-07-19
+===================
+
+Added
+-----
+
+- Add base ``ReportingAPIClient`` implementation using OAuth for authentication
+- Rename to ``reporting_api_client``.

{jampp_reporting_api_client-0.3.0 → jampp_reporting_api_client-0.3.2}/jampp_reporting_api_client.egg-info/SOURCES.txt

@@ -1,6 +1,8 @@
 CHANGELOG.rst
 MANIFEST.in
 README.rst
+requirements-dev.in
+requirements.in
 setup.cfg
 setup.py
 jampp_reporting_api_client.egg-info/PKG-INFO
@@ -13,4 +15,5 @@ reporting_api_client/VERSION
 reporting_api_client/__init__.py
 reporting_api_client/client.py
 reporting_api_client/oauth/__init__.py
-reporting_api_client/oauth/transport.py
+reporting_api_client/oauth/transport.py
+tests/test_client.py

jampp_reporting_api_client-0.3.2/jampp_reporting_api_client.egg-info/requires.txt

@@ -0,0 +1,15 @@
+gql>=3.0.0
+requests<3
+requests_toolbelt<2,>=1.0.0
+requests_oauthlib
+
+[dev]
+mypy
+pip-tools
+pre-commit>2.9.2
+pytest
+types-requests
+twine
+
+[pandas]
+pandas

jampp_reporting_api_client-0.3.2/reporting_api_client/VERSION

@@ -0,0 +1 @@
+0.3.2

jampp_reporting_api_client-0.3.2/requirements-dev.in

@@ -0,0 +1,7 @@
+-r requirements.in
+mypy
+pip-tools
+pre-commit>2.9.2
+pytest
+types-requests
+twine

jampp_reporting_api_client-0.3.2/requirements.in

@@ -0,0 +1,4 @@
+gql>=3.0.0
+requests<3
+requests_toolbelt>=1.0.0,<2
+requests_oauthlib

{jampp_reporting_api_client-0.3.0 → jampp_reporting_api_client-0.3.2}/setup.py

@@ -17,7 +17,9 @@ def parse_requirements(filename):
         ]
         # Remove pip flags
         requirements = [
-            line for line in requirements if not line.strip().startswith("--")
+            line for line in requirements
+            if not line.strip().startswith("--")
+                and not line.strip().startswith("-r")
         ]
         # Remove inline comments
         requirements = [
@@ -54,7 +56,7 @@ setup(
     author_email="data-infra@jampp.com",
     install_requires=[parse_requirements("requirements.in")],
     extras_require={
-        "dev": parse_requirements("requirements-dev.txt"),
+        "dev": parse_requirements("requirements-dev.in"),
         "pandas": ["pandas"],
     },
     long_description=readme + "\n\n" + history,

jampp_reporting_api_client-0.3.2/tests/test_client.py

@@ -0,0 +1,56 @@
+import datetime
+from unittest import TestCase
+from unittest.mock import patch, MagicMock
+
+
+from reporting_api_client.client import dict2object, ReportingAPIClient
+
+
+class TestClient(TestCase):
+    @patch("reporting_api_client.client.OAuth2Transport")
+    def setUp(self, transport_mock):
+        self.client = ReportingAPIClient(
+            "client_id",
+            "client_secret",
+            api_url="api_url",
+            auth_token_url="auth_token_url",
+        )
+        self.transport_mock = transport_mock
+
+    def test_dict2object(self):
+        self.assertEqual(dict2object({"a": "b"}), '{ a: "b" }')
+        self.assertEqual(dict2object({"a": 1}), "{ a: 1 }")
+        self.assertEqual(dict2object({"a": 1.1}), "{ a: 1.1 }")
+        self.assertEqual(dict2object({"a": {"b": "c"}}), '{ a: { b: "c" } }')
+
+    def test_init(self):
+        self.transport_mock.assert_called_with(
+            "api_url", "client_id", "client_secret", "auth_token_url"
+        )
+
+    def test_pivot(self):
+        to_frame_mock = MagicMock()
+        self.client.to_frame = to_frame_mock
+        self.client.pivot(
+            from_=datetime.datetime(2022, 1, 1),
+            to_=datetime.datetime(2022, 1, 2),
+            metrics=["clicks", "installs"],
+            granularity="DAILY",
+            filter_={"campaignId": {"isIn": [1, 2, 3]}},
+            context={"sqlTimeZone": "America/Buenos_Aires"},
+            dimensions=["date", "app"],
+            cohort_type="TOUCH",
+            cohort_window=datetime.timedelta(hours=10),
+            cleanup={"clicks": {"greaterThan": 1}},
+        )
+        query = to_frame_mock.call_args[0][0]
+        self.assertRegex(query, r"from: \"2022-01-01T00:00:00\"")
+        self.assertRegex(query, r"to: \"2022-01-02T00:00:00\"")
+        self.assertRegex(query, r"granularity: DAILY")
+        self.assertRegex(query, r"filter: \{ campaignId: \{ isIn: \[1, 2, 3\] \} \}")
+        self.assertRegex(
+            query, r"context: \{ sqlTimeZone: \"America\/Buenos_Aires\" \}"
+        )
+        self.assertRegex(query, r"cohortType: TOUCH")
+        self.assertRegex(query, r"cohortWindow: { period: HOURS, amount: 10 }")
+        self.assertRegex(query, r"results \{ date, app, clicks, installs \}")

jampp_reporting_api_client-0.3.0/MANIFEST.in

@@ -1,2 +0,0 @@
-include CHANGELOG.rst
-include README.rst

jampp_reporting_api_client-0.3.0/PKG-INFO

@@ -1,109 +0,0 @@
-Metadata-Version: 2.1
-Name: jampp_reporting_api_client
-Version: 0.3.0
-Summary: Client for Reporting API.
-Home-page: https://github.com/jampp/reporting-api-client
-Author: Jampp
-Author-email: data-infra@jampp.com
-License: UNKNOWN
-Description: ====================
-        Reporting API Client
-        ====================
-        
-        This is a Python Client for `Jampp's Reporting API`_. For more information, check the `docs`.
-        
-        Features
-        ========
-        
-        * Execute Pivots in an user friendly manner.
-        * Execute raw GraphQL queries against the Reporting API.
-        
-        
-        Basic Usage
-        ===========
-        
-        .. code-block:: python
-        
-            import os
-        
-            from reporting_api_client import ReportingAPIClient
-        
-        
-            client = ReportingAPIClient(os.environ["CLIENT_ID"], os.environ["CLIENT_SECRET"])
-            query = """{
-                pivot(from: "2022-07-01", to: "2022-07-02", granularity: DAILY) {
-                    results {
-                        clicks
-                    }
-                }
-            }"""
-        
-            result = client.query(query)
-            print(result)
-        
-        
-        Executing the above code should output a result similar to the following:
-        
-          .. code-block:: console
-        
-              $ python example.py
-              {'pivot': {'results': [{'clicks': 123456}]}}
-        
-        .. _`Jampp's Reporting API`: https://developers.jampp.com/docs/reporting-api/
-        .. _docs: https://developers.jampp.com/docs/reporting-api-client/
-        
-        
-        .. _changelog:
-        
-        ==========
-        Change Log
-        ==========
-        
-        All notable changes to this project will be documented here.
-        
-        Sort subsections like so: Added, Bugfixes, Improvements, Technical tasks.
-        Group anything an end user shouldn't care deeply about into technical
-        tasks, even if they're technically bugs. Only include as "bugfixes"
-        bugs with user-visible outcomes.
-        
-        When major components get significant changes worthy of mention, they
-        can be described in a Major section.
-        
-        
-        v0.3.0 - 2022-09-12
-        ===================
-        
-        Added
-        -----
-        
-        - Add workflows for CI and publishing to PyPI.
-        - Host documentation publically.
-        
-        Changed
-        -------
-        
-        - Remove Jampp's refferences.
-        
-        
-        v0.2.0 - 2022-08-29
-        ===================
-        
-        Added
-        -----
-        
-        - Remove need of introspection on client.
-        
-        
-        v0.1.0 - 2022-07-19
-        ===================
-        
-        Added
-        -----
-        
-        - Add base ``ReportingAPIClient`` implementation using OAuth for authentication
-        - Rename to ``reporting_api_client``.
-        
-Platform: UNKNOWN
-Description-Content-Type: text/x-rst
-Provides-Extra: dev
-Provides-Extra: pandas

jampp_reporting_api_client-0.3.0/jampp_reporting_api_client.egg-info/PKG-INFO

@@ -1,109 +0,0 @@
-Metadata-Version: 2.1
-Name: jampp-reporting-api-client
-Version: 0.3.0
-Summary: Client for Reporting API.
-Home-page: https://github.com/jampp/reporting-api-client
-Author: Jampp
-Author-email: data-infra@jampp.com
-License: UNKNOWN
-Description: ====================
-        Reporting API Client
-        ====================
-        
-        This is a Python Client for `Jampp's Reporting API`_. For more information, check the `docs`.
-        
-        Features
-        ========
-        
-        * Execute Pivots in an user friendly manner.
-        * Execute raw GraphQL queries against the Reporting API.
-        
-        
-        Basic Usage
-        ===========
-        
-        .. code-block:: python
-        
-            import os
-        
-            from reporting_api_client import ReportingAPIClient
-        
-        
-            client = ReportingAPIClient(os.environ["CLIENT_ID"], os.environ["CLIENT_SECRET"])
-            query = """{
-                pivot(from: "2022-07-01", to: "2022-07-02", granularity: DAILY) {
-                    results {
-                        clicks
-                    }
-                }
-            }"""
-        
-            result = client.query(query)
-            print(result)
-        
-        
-        Executing the above code should output a result similar to the following:
-        
-          .. code-block:: console
-        
-              $ python example.py
-              {'pivot': {'results': [{'clicks': 123456}]}}
-        
-        .. _`Jampp's Reporting API`: https://developers.jampp.com/docs/reporting-api/
-        .. _docs: https://developers.jampp.com/docs/reporting-api-client/
-        
-        
-        .. _changelog:
-        
-        ==========
-        Change Log
-        ==========
-        
-        All notable changes to this project will be documented here.
-        
-        Sort subsections like so: Added, Bugfixes, Improvements, Technical tasks.
-        Group anything an end user shouldn't care deeply about into technical
-        tasks, even if they're technically bugs. Only include as "bugfixes"
-        bugs with user-visible outcomes.
-        
-        When major components get significant changes worthy of mention, they
-        can be described in a Major section.
-        
-        
-        v0.3.0 - 2022-09-12
-        ===================
-        
-        Added
-        -----
-        
-        - Add workflows for CI and publishing to PyPI.
-        - Host documentation publically.
-        
-        Changed
-        -------
-        
-        - Remove Jampp's refferences.
-        
-        
-        v0.2.0 - 2022-08-29
-        ===================
-        
-        Added
-        -----
-        
-        - Remove need of introspection on client.
-        
-        
-        v0.1.0 - 2022-07-19
-        ===================
-        
-        Added
-        -----
-        
-        - Add base ``ReportingAPIClient`` implementation using OAuth for authentication
-        - Rename to ``reporting_api_client``.
-        
-Platform: UNKNOWN
-Description-Content-Type: text/x-rst
-Provides-Extra: dev
-Provides-Extra: pandas

jampp_reporting_api_client-0.3.0/jampp_reporting_api_client.egg-info/requires.txt

@@ -1,63 +0,0 @@
-gql[requests]>=3.0.0
-requests_oauthlib
-
-[dev]
-attrs==21.4.0
-backoff==2.1.2
-bleach==5.0.1
-build==0.8.0
-certifi==2022.6.15
-cfgv==3.3.1
-charset-normalizer==2.1.0
-click==8.1.3
-commonmark==0.9.1
-distlib==0.3.5
-docutils==0.19
-filelock==3.7.1
-gql[requests]==3.4.0
-graphql-core==3.2.1
-identify==2.5.1
-idna==3.3
-importlib-metadata==4.12.0
-iniconfig==1.1.1
-keyring==23.7.0
-multidict==6.0.2
-mypy==0.971
-mypy-extensions==0.4.3
-nodeenv==1.7.0
-oauthlib==3.2.0
-packaging==21.3
-pep517==0.12.0
-pip-tools==6.8.0
-pkginfo==1.8.3
-platformdirs==2.5.2
-pluggy==1.0.0
-pre-commit==2.20.0
-py==1.11.0
-pygments==2.12.0
-pyparsing==3.0.9
-pytest==7.1.2
-pyyaml==6.0
-readme-renderer==35.0
-requests==2.28.1
-requests-oauthlib==1.3.1
-requests-toolbelt==0.9.1
-rfc3986==2.0.0
-rich==12.5.1
-six==1.16.0
-toml==0.10.2
-tomli==2.0.1
-twine==4.0.1
-typed-ast==1.5.4
-types-requests==2.28.9
-types-urllib3==1.26.23
-typing-extensions==4.3.0
-urllib3==1.26.10
-virtualenv==20.15.1
-webencodings==0.5.1
-wheel==0.37.1
-yarl==1.7.2
-zipp==3.8.1
-
-[pandas]
-pandas

jampp_reporting_api_client-0.3.0/reporting_api_client/VERSION

@@ -1 +0,0 @@
-0.3.0