pub-analyzer 0.3.0__tar.gz → 0.4.0__tar.gz

{pub_analyzer-0.3.0 → pub_analyzer-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pub-analyzer
-Version: 0.3.0
+Version: 0.4.0
 Summary: A text user interface, written in python, which automates the generation of scientific production reports using OpenAlex
 Home-page: https://github.com/alejandrgaspar/pub-analyzer
 License: MIT
@@ -23,10 +23,10 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Typing :: Typed
 Requires-Dist: httpx (==0.27.0)
-Requires-Dist: jinja2 (==3.1.3)
-Requires-Dist: pydantic (==2.7.1)
-Requires-Dist: textual (==0.58.0)
-Requires-Dist: typst (==0.11.0)
+Requires-Dist: jinja2 (==3.1.4)
+Requires-Dist: pydantic (==2.7.4)
+Requires-Dist: textual (==0.70.0)
+Requires-Dist: typst (==0.11.1)
 Project-URL: Documentation, https://pub-analyzer.com/
 Project-URL: Repository, https://github.com/alejandrgaspar/pub-analyzer
 Description-Content-Type: text/markdown

{pub_analyzer-0.3.0 → pub_analyzer-0.4.0}/pub_analyzer/css/main.tcss

@@ -19,20 +19,26 @@ Body {
 Footer {
     dock: bottom;
     background: $primary-color;
-}
-
-Footer > .footer--highlight {
-    background: $primary-color-accent;
-}
-
-Footer > .footer--highlight-key {
-    background: $primary-color-highlight;
-    text-style: bold;
-}
 
-Footer > .footer--key {
-    text-style: bold;
-    background: $primary-color-accent
+    FooterKey {
+        background: $primary-color;
+        color: white;
+
+        .footer-key--key {
+            text-style: bold;
+            color: white;
+            background: $primary-color-accent;
+        }
+
+        &:hover {
+            background: $primary-color-highlight;
+            color: white;
+            text-style: bold;
+            .footer-key--key {
+                background: $primary-color-accent;
+            }
+        }
+    }
 }
 
 LoadingIndicator {

pub_analyzer-0.4.0/pub_analyzer/internal/templates/author/author_summary.typ

@@ -0,0 +1,112 @@
+// Author Summary
+= Author.
+
+#let summary-card(title: "Title", body) = {
+  return block(
+    width: 100%,
+    height: 150pt,
+    fill: rgb("e5e7eb"),
+    stroke: 1pt,
+    radius: 2pt,
+  )[
+    #v(20pt)
+    #align(center)[#text(size: 12pt)[#title]]
+    #v(5pt)
+    #block(width: 100%, inset: (x: 20pt))[#body]
+  ]
+}
+
+// Cards
+#grid(
+  columns: (1fr, 1fr, 1fr),
+  column-gutter: 15pt,
+  [
+    // Last institution.
+    #summary-card(title:"Last institution:")[
+      {% if report.author.last_known_institutions%}
+      {% set last_known_institution = report.author.last_known_institutions[0] %}
+      #grid(
+        rows: auto, row-gutter: 10pt,
+
+        [*Name:* {{ last_known_institution.display_name }}],
+        [*Country:* {{ last_known_institution.country_code }}],
+        [*Type:* {{ last_known_institution.type.value|capitalize }}],
+      )
+      {% endif %}
+    ]
+  ],
+  [
+    // Author identifiers.
+    #summary-card(title:"Identifiers:")[
+      #grid(
+        rows: auto, row-gutter: 10pt,
+        {% for key, value in report.author.ids.model_dump().items() %}
+          {% if value %}
+          [- #underline( [#link("{{ value }}")[{{ key }}]] )],
+          {% endif %}
+        {% endfor %}
+      )
+    ]
+  ],
+  [
+    // Citation metrics.
+    #summary-card(title: "Citation metrics:")[
+      #grid(
+        rows: auto, row-gutter: 10pt,
+
+        [*2-year mean:* {{ report.author.summary_stats.two_yr_mean_citedness|round(5) }}],
+        [*h-index:* {{ report.author.summary_stats.h_index }}],
+        [*i10 index:* {{ report.author.summary_stats.i10_index }}]
+      )
+    ]
+  ],
+)
+
+#v(10pt)
+#align(center, text(11pt)[_Counts by year_])
+#grid(
+  columns: (1fr, 1fr),
+  column-gutter: 15pt,
+  align: (auto, horizon),
+
+  [
+    #table(
+      columns: (1fr, 2fr, 2fr),
+      inset: 8pt,
+      align: horizon,
+      // Headers
+      [*Year*], [*Works count*], [*Cited by count*],
+
+      // Content
+      {% set max_year_count = 0 %}
+      {% for year_count in report.author.counts_by_year[:8] %}
+      [{{ year_count.year }}], [{{ year_count.works_count }}], [{{ year_count.cited_by_count }}],
+      {% set max_year_count = year_count %}
+      {% endfor %}
+    )
+  ],
+  grid.cell(
+    inset: (x: 10pt, bottom: 10pt, top: 2.5pt),
+    stroke: 1pt
+  )[
+    #align(center, text(10pt)[Cites by year])
+    #v(5pt)
+    #canvas(length: 100%, {
+      plot.plot(
+        size: (0.90, 0.48),
+        axis-style: "scientific-auto",
+        plot-style: (stroke: (1pt + BLUE),),
+        x-min: auto, x-max: auto,
+        x-tick-step: 1, y-tick-step: auto,
+        x-label: none, y-label: none,
+        {
+          plot.add((
+            {% for year_count in report.author.counts_by_year[:8] %}
+            ({{ year_count.year }}, {{ year_count.cited_by_count }}),
+            {% endfor %}
+          ))
+      })
+    })
+  ]
+)
+#pagebreak()

{pub_analyzer-0.3.0 → pub_analyzer-0.4.0}/pub_analyzer/internal/templates/author/report.typ

@@ -1,6 +1,18 @@
 // This document was generated using Pub Analyzer.
 // https://pub-analyzer.com
 
+// Packages
+#import "@preview/cetz:0.2.2": canvas, plot, chart, palette
+
+// Colors
+#let BLUE = rgb("#42a2f8")
+#let GREEN = rgb("#82d452")
+#let GRAY = rgb("#929292")
+#let YELLOW = rgb("#f0bb40")
+#let RED = rgb("#eb4025")
+#let PURPLE = rgb("#c33375")
+
+#let colors = (BLUE, GREEN, GRAY, YELLOW, RED, PURPLE)
 
 // Page Layoput
 #set page("us-letter")

{pub_analyzer-0.3.0 → pub_analyzer-0.4.0}/pub_analyzer/internal/templates/author/sources.typ

@@ -10,7 +10,7 @@
 
   // Content
   {% for source in report.sources_summary.sources %}
-  [#underline[3.{{ loop.index }}. #label("source_{{ source.id.path.rpartition("/")[2] }}")]],
+  [3.{{ loop.index }}. #label("source_{{ source.id.path.rpartition("/")[2] }}")],
   [#underline([#link("{{ source.homepage_url }}")[#"{{ source.display_name }}"]])],
   [{{ source.host_organization_name or "-" }}],
   [{{source.type }}],

pub_analyzer-0.4.0/pub_analyzer/internal/templates/author/works.typ

@@ -0,0 +1,152 @@
+// Works
+= Works.
+
+#let works_metrics_card(title: "Title", graph, body) = {
+  grid(
+    rows: (18pt, 175pt, 60pt),
+    columns: 100%,
+
+    [
+      #block(width: 100%, height: 100%)[
+        #align(center + horizon)[#text(style: "italic")[#title]]
+      ]
+    ],
+    [
+      #block(width: 100%, height: 100%)[
+        #align(center + horizon)[#graph]
+      ]
+    ],
+    [
+      #block(width: 100%, height: 100%, inset: (x: 5pt, y: 10pt))[#body]
+    ],
+  )
+}
+
+#grid(
+  columns: (1fr, 1fr, 1fr),
+  column-gutter: 15pt,
+  [
+    #let graph = {
+      canvas(length: 35%, {
+        chart.piechart(
+          (
+            {{ report.citation_summary.type_a_count }}, // Type A
+            {{ report.citation_summary.type_b_count }}  // Type B
+          ),
+          radius: 1,
+          slice-style: (BLUE, GREEN),
+          outer-label: (content: "%", radius: 115%),
+        )
+      })
+    }
+
+    #works_metrics_card(title: "Citation metrics", graph)[
+      #grid(
+        rows: auto, row-gutter: 10pt,
+        columns: (1fr, 1fr),
+
+        grid.cell(colspan: 2)[
+          *Count:* {{ report.citation_summary.type_a_count + report.citation_summary.type_b_count }}
+        ],
+        [#box(height: 7pt, width: 7pt, fill: BLUE) *Type A:* {{ report.citation_summary.type_a_count }}],
+        [#box(height: 7pt, width: 7pt, fill: GREEN) *Type B:* {{ report.citation_summary.type_b_count }}],
+      )
+    ]
+  ],
+  [
+    #let graph = {
+      canvas(length: 35%, {
+        chart.columnchart(
+          size: (2.45, 2.0),
+          y-grid: false,
+          bar-style: palette.new(
+            base: (stroke: none, fill: none),
+            colors: colors
+          ),
+          (
+            {% for work_type in report.works_type_summary[:4] %}
+            ("{{ work_type.type_name[:2]|capitalize }}", {{ work_type.count }}),
+            {% endfor %}
+          )
+        )
+      })
+    }
+    #works_metrics_card(title: "Work Type", graph)[
+      #grid(
+        rows: auto, row-gutter: 10pt,
+        columns: (1fr, 1fr),
+        column-gutter: 5pt,
+
+        grid.cell(colspan: 2)[
+          *Count:* {{ report.open_access_summary.model_dump().items()|sum(attribute="1") }}
+        ],
+
+        {% for work_type in report.works_type_summary[:4] %}
+        [
+          #box(height: 7pt, width: 7pt, fill: colors.at({{ loop.index0 }})) *{{ work_type.type_name|capitalize }}:* {{ work_type.count }}
+        ],
+        {% endfor %}
+      )
+    ]
+  ],
+  [
+    #let graph = {
+      canvas(length: 35%, {
+        chart.piechart(
+          (
+            {{report.open_access_summary.gold}},   // Gold
+            {{report.open_access_summary.green}},  // Green
+            {{report.open_access_summary.hybrid}}, // Hybrid
+            {{report.open_access_summary.bronze}}, // Bronze
+            {{report.open_access_summary.closed}}, // Closed
+          ),
+          radius: 1,
+          inner-radius: .4,
+          slice-style: (YELLOW, GREEN, RED, BLUE, GRAY),
+          outer-label: (content: "%", radius: 115%),
+        )
+      })
+    }
+    #works_metrics_card(title: "Open Access", graph)[
+      #grid(
+        rows: auto, row-gutter: 10pt,
+        columns: (1fr, 1fr, 1fr),
+        column-gutter: 5pt,
+
+        grid.cell(colspan: 3)[
+          *Count:* {{ report.open_access_summary.model_dump().items()|sum(attribute="1") }}
+        ],
+
+        [#box(height: 7pt, width: 7pt, fill: YELLOW) *Gold:* {{report.open_access_summary.gold}}],
+        [#box(height: 7pt, width: 7pt, fill: GREEN) *Green:* {{report.open_access_summary.green}}],
+        [#box(height: 7pt, width: 7pt, fill: BLUE) *Bronze:* {{report.open_access_summary.bronze}}],
+
+        [#box(height: 7pt, width: 7pt, fill: GRAY) *Closed:* {{report.open_access_summary.closed}}],
+        [#box(height: 7pt, width: 7pt, fill: RED) *Hybrid:* {{report.open_access_summary.hybrid}}],
+      )
+    ]
+  ],
+)
+
+#align(center, text(11pt)[Works from {{ report.works[0].work.publication_year }} to {{ report.works[-1].work.publication_year }}])
+#table(
+  columns: (auto, 3fr, auto, auto, auto, auto, auto, auto, auto),
+  inset: 8pt,
+  align: horizon,
+  // Headers
+  [], [*Title*], [*Type*], [*DOI*], [*Publication Date*], [*Cited by count*], [*Type A*], [*Type B*], [*OA*],
+
+  // Content
+  {% for work in report.works %}
+  [#underline([#link(label("work_{{ loop.index }}"))[@work_{{ loop.index }}]])],
+  [#"{{ work.work.title.replace('"', '\\"') }}"],
+  [{{ work.work.type }}],
+  [{% if work.work.ids.doi %}#underline([#link("{{ work.work.ids.doi }}")[DOI]]){% else %}-{% endif %}],
+  [{{ work.work.publication_date }}],
+  [{{ work.citation_summary.type_a_count + work.citation_summary.type_b_count }}],
+  [{{ work.citation_summary.type_a_count }}],
+  [{{ work.citation_summary.type_b_count }}],
+  [{{ work.work.open_access.oa_status.value }}],
+  {% endfor %}
+)
+#pagebreak()

{pub_analyzer-0.3.0 → pub_analyzer-0.4.0}/pub_analyzer/internal/templates/author/works_extended.typ

@@ -1,11 +1,10 @@
-== Extended info.
 {% for work in report.works %}
 
 {% if not loop.first %}
 #pagebreak()
 {% endif %}
 
-=== #text()[#"{{ work.work.title.replace('"', '\\"') }}"] <work_{{ loop.index }}>
+== #text()[#"{{ work.work.title.replace('"', '\\"') }}"] <work_{{ loop.index }}>
 
 #linebreak()
 

{pub_analyzer-0.3.0 → pub_analyzer-0.4.0}/pub_analyzer/main.py

@@ -43,8 +43,12 @@ class PubAnalyzerApp(App[DOMNode]):
 
     def compose(self) -> ComposeResult:
         """Create child widgets for the app."""
+        footer = Footer()
+        footer.upper_case_keys = True
+        footer.ctrl_to_caret = False
+
         yield Body()
-        yield Footer()
+        yield footer
 
     def action_toggle_dark(self) -> None:
         """Toggle dark mode."""

{pub_analyzer-0.3.0 → pub_analyzer-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "pub-analyzer"
-version = "0.3.0"
+version = "0.4.0"
 description = "A text user interface, written in python, which automates the generation of scientific production reports using OpenAlex"
 
 authors = ["Alejandro Gaspar <alejandro@gaspar.land>"]
@@ -40,21 +40,21 @@ pub-analyzer = "pub_analyzer.main:run"
 [tool.poetry.dependencies]
 python = "^3.10"
 
-textual = "0.58.0"
+textual = "0.70.0"
 httpx = "0.27.0"
-pydantic = "2.7.1"
+pydantic = "2.7.4"
 
-typst = "0.11.0"
-jinja2 = "3.1.3"
+typst = "0.11.1"
+jinja2 = "3.1.4"
 
 [tool.poetry.group.dev.dependencies]
 textual-dev = "1.5.1"
 
-pre-commit = "3.7.0"
+pre-commit = "3.7.1"
 mypy = "1.10.0"
-ruff = "0.4.2"
+ruff = "0.4.8"
 
-pytest = "8.2.0"
+pytest = "8.2.2"
 pytest-asyncio = "0.21.1"
 respx = "0.21.1"
 vcrpy = "6.0.1"
@@ -64,8 +64,8 @@ pytest-recording = "0.13.1"
 mkdocs = "1.5.3"
 mkdocs-material = "9.5.18"
 
-mkdocstrings = {extras = ["python"], version = "0.25.0"}
-mkdocstrings-python = "1.10.0"
+mkdocstrings = {extras = ["python"], version = "0.25.1"}
+mkdocstrings-python = "1.10.3"
 
 [tool.mypy]
 strict = true

pub_analyzer-0.3.0/pub_analyzer/internal/templates/author/author_summary.typ

@@ -1,97 +0,0 @@
-// Author Summary
-= Author.
-
-// Cards
-#grid(
-  columns: (1fr, 1fr, 1fr),
-  column-gutter: 15pt,
-  [
-    // Card
-    #rect(
-      width: 100%,
-      height: 150pt,
-      fill: rgb("e5e7eb"),
-      stroke: 1pt,
-      radius: 2pt,
-      [#linebreak()
-        #grid(
-        columns: 1fr,
-        row-gutter: (15pt, 12pt),
-
-        // Card Title
-        [#align(center)[#text(size: 12pt)[Last institution:]]],
-
-        // Card content
-        {% if report.author.last_known_institutions%}
-        {% set last_known_institution = report.author.last_known_institutions[0] %}
-        [#align(left)[#text(size: 10pt)[- *Name:* {{ last_known_institution.display_name }}]]],
-        [#align(left)[#text(size: 10pt)[- *Country:* MX]]],
-        [#align(left)[#text(size: 10pt)[- *Type:* education]]],
-        {% endif %}
-      )]
-    )
-  ],
-  [
-    // Card
-    #rect(
-      width: 100%,
-      height: 150pt,
-      fill: rgb("e5e7eb"),
-      stroke: 1pt,
-      radius: 2pt,
-      [#linebreak()
-        #grid(
-        columns: 1fr,
-        row-gutter: (15pt, 12pt),
-
-        // Card Title
-        [#align(center)[#text(size: 12pt)[Identifiers:]]],
-
-        // Card content
-        {% for key, value in report.author.ids.model_dump().items() %}
-            {% if value %}
-            [#align(left)[#text(size: 10pt)[- #underline( [#link("{{ value }}")[{{ key }}]] )]]],
-            {% endif %}
-        {% endfor %}
-      )]
-    )
-  ],
-  [
-    // Card
-    #rect(
-      width: 100%,
-      height: 150pt,
-      fill: rgb("e5e7eb"),
-      stroke: 1pt,
-      radius: 2pt,
-      [#linebreak()
-        #grid(
-        columns: 1fr,
-        row-gutter: (15pt, 12pt),
-
-        // Card Title
-        [#align(center)[#text(size: 12pt)[Citation metrics:]]],
-
-        // Card content
-        [#align(left)[#text(size: 10pt)[- *2-year mean:* {{ report.author.summary_stats.two_yr_mean_citedness|round(5) }}]]],
-        [#align(left)[#text(size: 10pt)[- *h-index:* {{ report.author.summary_stats.h_index }}]]],
-        [#align(left)[#text(size: 10pt)[- *i10 index:* {{ report.author.summary_stats.i10_index }}]]],
-      )]
-    )
-  ],
-)
-
-#align(center, text(11pt)[_Counts by year_])
-#table(
-  columns: (1fr, 2fr, 2fr),
-  inset: 8pt,
-  align: horizon,
-  // Headers
-  [*Year*], [*Works count*], [*Cited by count*],
-
-  // Content
-  {% for year_count in report.author.counts_by_year[:8] %}
-  [{{ year_count.year }}], [{{ year_count.works_count }}], [{{ year_count.cited_by_count }}],
-  {% endfor %}
-)
-#pagebreak()

pub_analyzer-0.3.0/pub_analyzer/internal/templates/author/works.typ

@@ -1,65 +0,0 @@
-// Works
-= Works.
-
-#linebreak()
-
-#grid(
-  columns: (1fr, 1fr, 1fr),
-  column-gutter: 30pt,
-  [
-    #align(center)[_Citation metrics_]
-    #parbreak()
-    - *Count:* {{ report.citation_summary.type_a_count + report.citation_summary.type_b_count }}
-    - *Type A:* {{ report.citation_summary.type_a_count }}
-    - *Type B:* {{ report.citation_summary.type_b_count }}
-  ],
-  [
-    #align(center)[_Work Type_]
-    #parbreak()
-    {% for work_type in report.works_type_summary %}
-    - *{{ work_type.type_name }}:* {{ work_type.count }}
-    {% endfor %}
-  ],
-  [
-    #align(center)[_Open Access_]
-    #parbreak()
-    #grid(
-      columns: (1fr, 1fr),
-      column-gutter: 15pt,
-      [
-        - *gold:* {{report.open_access_summary.gold}}
-        - *green:* {{report.open_access_summary.green}}
-        - *hybrid:* {{report.open_access_summary.hybrid}}
-      ],
-      [
-        - *bronze:* {{report.open_access_summary.bronze}}
-        - *closed:* {{report.open_access_summary.closed}}
-      ],
-    )
-  ],
-)
-
-#linebreak()
-
-#align(center, text(11pt)[Works from {{ report.works[0].work.publication_year }} to {{ report.works[-1].work.publication_year }}])
-#table(
-  columns: (auto, 3fr, auto, auto, auto, auto, auto, auto, auto),
-  inset: 8pt,
-  align: horizon,
-  // Headers
-  [], [*Title*], [*Type*], [*DOI*], [*Publication Date*], [*Cited by count*], [*Type A*], [*Type B*], [*OA*],
-
-  // Content
-  {% for work in report.works %}
-  [#underline([#link(label("work_{{ loop.index }}"))[@work_{{ loop.index }}]])],
-  [#"{{ work.work.title.replace('"', '\\"') }}"],
-  [{{ work.work.type }}],
-  [{% if work.work.ids.doi %}#underline([#link("{{ work.work.ids.doi }}")[DOI]]){% else %}-{% endif %}],
-  [{{ work.work.publication_date }}],
-  [{{ work.citation_summary.type_a_count + work.citation_summary.type_b_count }}],
-  [{{ work.citation_summary.type_a_count }}],
-  [{{ work.citation_summary.type_b_count }}],
-  [{{ work.work.open_access.oa_status.value }}],
-  {% endfor %}
-)
-#pagebreak()