[CAT-62] create python client for dataset user reporting (#108)

* Create user Metrics Reporting
* Add @pastap 's work on pagination.

Co-authored-by: @pastap

Author: goatrocks

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d7b739f8a313db4ed3894e3221d4cf10
+config: c5cbe4a7624d7549079e7846d28d9da6
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_sources/docextract_settings.rst.txt

@@ -122,8 +122,8 @@ Force Render
 
 Setting::
 
-    "force_render": True
-    "force_render": False (default)
+    "force_render": True (default since IPA 4.7.0)
+    "force_render": False (default prior to IPA 4.7.0)
 
 Force rendering of the document. Beware of increased computation cost for increased reliability of page rendering.
 Only use this setting if you know you’ve got a problem that requires it.

docs/_sources/examples.rst.txt

@@ -14,3 +14,4 @@ Examples
     image-dataset-ex
     image-predictions-ex
     submission-ex
+    user-metrics-ex

docs/_sources/index.rst.txt

@@ -40,6 +40,7 @@ Reference
     exports
     filters
     graphql_queries
+    user_metrics
 
 **Types**
 
@@ -50,3 +51,4 @@ Reference
     jobs-type
     model-group-type
     model-type
+    user-metrics-types

docs/_sources/user-metrics-ex.rst.txt

@@ -0,0 +1,6 @@
+Fetching User Metrics
+***********************************************************
+
+An example that illustrates how to fetch user metric data.
+
+.. literalinclude:: ../examples/get-user-metrics.py

docs/_sources/user-metrics-types.rst.txt

@@ -0,0 +1,13 @@
+***********
+User Metrics Types
+***********
+
+.. automodule:: indico.types.user_metrics
+.. autoclass:: indico.types.user_metrics.AppRoles
+.. autoclass:: indico.types.user_metrics.UserDatasets
+.. autoclass:: indico.types.user_metrics.UserSummaryCounts
+.. autoclass:: indico.types.user_metrics.UserSnapshot
+.. autoclass:: indico.types.user_metrics.UserSummary
+.. autoclass:: indico.types.user_metrics.DatasetRole
+.. autoclass:: indico.types.user_metrics.UserChangelog
+.. autoclass:: indico.types.user_metrics.UserChangelogReport

docs/_sources/user_metrics.rst.txt

@@ -0,0 +1,9 @@
+*****************
+User Metrics
+*****************
+
+.. autoclass:: indico.queries.usermetrics.GetUserSnapshots
+.. autoclass:: indico.queries.usermetrics.GetUserChangelog
+.. autoclass:: indico.queries.usermetrics.GetUserSummary
+.. autoclass:: indico.queries.usermetrics.GenerateChangelogReport
+

docs/_sources/user_metrics_ex.rst.txt

@@ -0,0 +1,6 @@
+Fetching User Metrics
+***********************************************************
+
+An example that illustrates how to fetch user metric data.
+
+.. literalinclude:: ../examples/get-user-metrics.py

docs/_sources/user_metrics_types.rst.txt

@@ -0,0 +1,13 @@
+***********
+User Metrics Types
+***********
+
+.. automodule:: indico.types.user_metrics
+.. autoclass:: indico.types.user_metrics.AppRoles
+.. autoclass:: indico.types.user_metrics.UserDatasets
+.. autoclass:: indico.types.user_metrics.UserSummaryCounts
+.. autoclass:: indico.types.user_metrics.UserSnapshot
+.. autoclass:: indico.types.user_metrics.UserSummary
+.. autoclass:: indico.types.user_metrics.DatasetRole
+.. autoclass:: indico.types.user_metrics.UserChangelog
+.. autoclass:: indico.types.user_metrics.UserChangelogReport

docs/_static/basic.css

@@ -130,7 +130,7 @@ ul.search li a {
     font-weight: bold;
 }
 
-ul.search li div.context {
+ul.search li p.context {
     color: #888;
     margin: 2px 0 0 30px;
     text-align: left;
@@ -277,25 +277,25 @@ p.rubric {
     font-weight: bold;
 }
 
-img.align-left, .figure.align-left, object.align-left {
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
     clear: left;
     float: left;
     margin-right: 1em;
 }
 
-img.align-right, .figure.align-right, object.align-right {
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
     clear: right;
     float: right;
     margin-left: 1em;
 }
 
-img.align-center, .figure.align-center, object.align-center {
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
   display: block;
   margin-left: auto;
   margin-right: auto;
 }
 
-img.align-default, .figure.align-default {
+img.align-default, figure.align-default, .figure.align-default {
   display: block;
   margin-left: auto;
   margin-right: auto;
@@ -319,7 +319,8 @@ img.align-default, .figure.align-default {
 
 /* -- sidebars -------------------------------------------------------------- */
 
-div.sidebar {
+div.sidebar,
+aside.sidebar {
     margin: 0 0 0.5em 1em;
     border: 1px solid #ddb;
     padding: 7px;
@@ -377,12 +378,14 @@ div.body p.centered {
 /* -- content of sidebars/topics/admonitions -------------------------------- */
 
 div.sidebar > :last-child,
+aside.sidebar > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
     margin-bottom: 0;
 }
 
 div.sidebar::after,
+aside.sidebar::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -455,20 +458,22 @@ td > :last-child {
 
 /* -- figures --------------------------------------------------------------- */
 
-div.figure {
+div.figure, figure {
     margin: 0.5em;
     padding: 0.5em;
 }
 
-div.figure p.caption {
+div.figure p.caption, figcaption {
     padding: 0.3em;
 }
 
-div.figure p.caption span.caption-number {
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
     font-style: italic;
 }
 
-div.figure p.caption span.caption-text {
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
 }
 
 /* -- field list styles ----------------------------------------------------- */
@@ -503,6 +508,63 @@ table.hlist td {
     vertical-align: top;
 }
 
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+	font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+    background-color: transparent;
+    font-weight: bold;
+}
+
+.sig-name {
+	font-size: 1.1em;
+}
+
+code.descname {
+    font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+    background-color: transparent;
+}
+
+.optional {
+    font-size: 1.3em;
+}
+
+.sig-paren {
+    font-size: larger;
+}
+
+.sig-param.n {
+	font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+	font-family: unset;
+}
+
+.sig.c   .k, .sig.c   .kt,
+.sig.cpp .k, .sig.cpp .kt {
+	color: #0033B3;
+}
+
+.sig.c   .m,
+.sig.cpp .m {
+	color: #1750EB;
+}
+
+.sig.c   .s, .sig.c   .sc,
+.sig.cpp .s, .sig.cpp .sc {
+	color: #067D17;
+}
+
 
 /* -- other body styles ----------------------------------------------------- */
 
@@ -629,14 +691,6 @@ dl.glossary dt {
     font-size: 1.1em;
 }
 
-.optional {
-    font-size: 1.3em;
-}
-
-.sig-paren {
-    font-size: larger;
-}
-
 .versionmodified {
     font-style: italic;
 }
@@ -766,7 +820,11 @@ div.code-block-caption code {
 table.highlighttable td.linenos,
 span.linenos,
 div.doctest > div.highlight span.gp {  /* gp: Generic.Prompt */
-    user-select: none;
+  user-select: none;
+  -webkit-user-select: text; /* Safari fallback only */
+  -webkit-user-select: none; /* Chrome/Safari */
+  -moz-user-select: none; /* Firefox */
+  -ms-user-select: none; /* IE10+ */
 }
 
 div.code-block-caption span.caption-number {
@@ -781,16 +839,6 @@ div.literal-block-wrapper {
     margin: 1em 0;
 }
 
-code.descname {
-    background-color: transparent;
-    font-weight: bold;
-    font-size: 1.2em;
-}
-
-code.descclassname {
-    background-color: transparent;
-}
-
 code.xref, a code {
     background-color: transparent;
     font-weight: bold;

docs/_static/pygments.css

@@ -1,5 +1,10 @@
+pre { line-height: 125%; }
+td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
+td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
+span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .highlight .hll { background-color: #ffffcc }
-.highlight  { background: #f8f8f8; }
+.highlight { background: #f8f8f8; }
 .highlight .c { color: #408080; font-style: italic } /* Comment */
 .highlight .err { border: 1px solid #FF0000 } /* Error */
 .highlight .k { color: #008000; font-weight: bold } /* Keyword */

docs/_static/searchtools.js

@@ -509,7 +509,7 @@ var Search = {
     var excerpt = ((start > 0) ? '...' : '') +
       $.trim(text.substr(start, 240)) +
       ((start + 240 - text.length) ? '...' : '');
-    var rv = $('<div class="context"></div>').text(excerpt);
+    var rv = $('<p class="context"></p>').text(excerpt);
     $.each(hlwords, function() {
       rv = rv.highlightText(this, 'highlighted');
     });