pub-analyzer 0.1.0__tar.gz → 0.4.1__tar.gz

{pub_analyzer-0.1.0 → pub_analyzer-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pub-analyzer
-Version: 0.1.0
+Version: 0.4.1
 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
@@ -20,19 +20,43 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Typing :: Typed
-Requires-Dist: httpx (==0.24.1)
-Requires-Dist: jinja2 (==3.1.2)
-Requires-Dist: pydantic (==2.3.0)
-Requires-Dist: textual (==0.34.0)
-Requires-Dist: typst (==0.7.0)
+Requires-Dist: httpx (==0.27.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
 
-Pub-Analyzer –[*Publication Analyzer*](https://github.com/alejandrgaspar/pub-analyzer)– is a Text User Interface –*TUI*–, written in Python, which automates the generation of scientific production reports using [*OpenAlex*](https://openalex.org/).
+<p align="center">
+    <img src="https://raw.githubusercontent.com/alejandrgaspar/pub-analyzer/main/docs/assets/img/logo.png" alt="PubAnalyzer splash image" width="275">
+</p>
+
+<p align="center">
+    <a href="https://github.com/alejandrgaspar/pub-analyzer/actions/workflows/python-test.yml" target="_blank">
+        <img src="https://github.com/alejandrgaspar/pub-analyzer/actions/workflows/python-test.yml/badge.svg?branch=main" alt="Test status">
+    </a>
+    <a href="https://pypi.org/project/pub-analyzer/" target="_blank">
+        <img src="https://img.shields.io/pypi/v/pub-analyzer?color=%230f80c1" alt="PyPI - Version">
+    </a>
+    <a href="https://pypi.org/project/pub-analyzer/" target="_blank">
+        <img src="https://img.shields.io/pypi/pyversions/pub-analyzer?color=%230f80c1" alt="PyPI - Python Version">
+    </a>
+    <a href="https://github.com/alejandrgaspar/pub-analyzer/blob/main/LICENSE" target="_blank">
+        <img src="https://img.shields.io/github/license/alejandrgaspar/pub-analyzer?color=%2331c553" alt="License MIT">
+    </a>
+</p>
+
+<p align="center">
+    Pub-Analyzer &mdash;<a href="https://github.com/alejandrgaspar/pub-analyzer" target="_blank"><em>Publication Analyzer</em></a>&mdash; is a Text User Interface &mdash;<em>TUI</em>&mdash; written in Python, which automates the generation of scientific production reports using <a href="https://openalex.org/" target="_blank"><em>OpenAlex</em></a>.
+</p>
+
+---
 
 ## What is Pub Analyzer for?
 

{pub_analyzer-0.1.0 → pub_analyzer-0.4.1}/README.md

@@ -1,6 +1,29 @@
 # Pub Analyzer
 
-Pub-Analyzer –[*Publication Analyzer*](https://github.com/alejandrgaspar/pub-analyzer)– is a Text User Interface –*TUI*–, written in Python, which automates the generation of scientific production reports using [*OpenAlex*](https://openalex.org/).
+<p align="center">
+    <img src="https://raw.githubusercontent.com/alejandrgaspar/pub-analyzer/main/docs/assets/img/logo.png" alt="PubAnalyzer splash image" width="275">
+</p>
+
+<p align="center">
+    <a href="https://github.com/alejandrgaspar/pub-analyzer/actions/workflows/python-test.yml" target="_blank">
+        <img src="https://github.com/alejandrgaspar/pub-analyzer/actions/workflows/python-test.yml/badge.svg?branch=main" alt="Test status">
+    </a>
+    <a href="https://pypi.org/project/pub-analyzer/" target="_blank">
+        <img src="https://img.shields.io/pypi/v/pub-analyzer?color=%230f80c1" alt="PyPI - Version">
+    </a>
+    <a href="https://pypi.org/project/pub-analyzer/" target="_blank">
+        <img src="https://img.shields.io/pypi/pyversions/pub-analyzer?color=%230f80c1" alt="PyPI - Python Version">
+    </a>
+    <a href="https://github.com/alejandrgaspar/pub-analyzer/blob/main/LICENSE" target="_blank">
+        <img src="https://img.shields.io/github/license/alejandrgaspar/pub-analyzer?color=%2331c553" alt="License MIT">
+    </a>
+</p>
+
+<p align="center">
+    Pub-Analyzer &mdash;<a href="https://github.com/alejandrgaspar/pub-analyzer" target="_blank"><em>Publication Analyzer</em></a>&mdash; is a Text User Interface &mdash;<em>TUI</em>&mdash; written in Python, which automates the generation of scientific production reports using <a href="https://openalex.org/" target="_blank"><em>OpenAlex</em></a>.
+</p>
+
+---
 
 ## What is Pub Analyzer for?
 

pub_analyzer-0.4.1/pub_analyzer/css/body.tcss

@@ -0,0 +1,87 @@
+/* COLORS */
+$bg-main-color: white;
+$bg-secondary-color: #e5e7eb;
+$text-primary-color: black;
+
+$bg-main-color-darken: #1e293b;
+$bg-secondary-color-darken: #0f172a;
+$text-primary-color-darken: white;
+
+/* SideBar CSS */
+SideBar {
+    dock: left;
+    width: 20;
+
+    background: $bg-secondary-color;
+    color: $text-primary-color;
+
+    Button {
+        text-align: start;
+    }
+
+    #sidebar-title {
+        width: 100%;
+        content-align: left middle;
+        text-style: bold;
+        border-bottom: heavy $text-primary-color;
+    }
+
+    .sidebar-options-column {
+        margin: 1;
+        padding: 1 1;
+    }
+
+    .sidebar-buttons-column {
+        height: 1fr;
+
+        .sidebar-option {
+            content-align: left middle;
+            margin: 1 0;
+            width: 100%;
+        }
+    }
+
+    #module-version-label {
+        color: $text-primary-color 25%;
+        text-align: center;
+        width: 100%;
+    }
+}
+
+.-dark-mode SideBar {
+    background: $bg-secondary-color-darken;
+    color: $text-primary-color-darken;
+
+    #sidebar-title {
+        border-bottom: heavy $text-primary-color-darken;
+    }
+
+    #module-version-label {
+        color: $text-primary-color-darken 25%;
+    }
+}
+
+/* Main Content CSS */
+MainContent {
+    background: $bg-main-color;
+    color: $text-primary-color;
+
+    padding: 2 1 0 1;
+    height: 100%;
+
+    .title {
+        content-align: left middle;
+        text-style: bold;
+        border-bottom: heavy $text-primary-color;
+        width: 100%
+    }
+}
+
+.-dark-mode MainContent {
+    background: $bg-main-color-darken;
+    color: $text-primary-color-darken;
+
+    .title {
+        border-bottom: heavy $text-primary-color-darken;
+    }
+}

{pub_analyzer-0.1.0 → pub_analyzer-0.4.1}/pub_analyzer/css/buttons.tcss

@@ -9,7 +9,6 @@ Button.-primary {
     color: white;
     border-top: tall $primary-color-highlight;
     border-bottom: tall black;
-
 }
 
 Button.-primary:hover {

pub_analyzer-0.4.1/pub_analyzer/css/collapsible.tcss

@@ -0,0 +1,31 @@
+/* COLORS */
+$bg-main-color: white;
+$bg-secondary-color: #e5e7eb;
+$bg-secondary-color-accent: #d1d5db;
+$text-primary-color: black;
+
+$bg-main-color-darken: #1e293b;
+$bg-secondary-color-darken: #0f172a;
+$text-primary-color-darken: black;
+
+CollapsibleTitle {
+    background: transparent;
+    color: $text-primary-color;
+}
+
+CollapsibleTitle:hover {
+    background: transparent;
+    text-style: bold;
+    color: $text-primary-color;
+}
+
+CollapsibleTitle:focus {
+    background: transparent;
+    text-style: bold;
+    color: $text-primary-color;
+}
+
+Collapsible {
+    background: transparent;
+    border: none;
+}

pub_analyzer-0.4.1/pub_analyzer/css/main.tcss

@@ -0,0 +1,50 @@
+/* COLORS */
+$primary-color: #b91c1c;
+$primary-color-accent: #991b1b;
+$primary-color-highlight: #dc2626;
+
+* {
+    scrollbar-color: $primary-color;
+    scrollbar-color-active: $primary-color-accent;
+    scrollbar-color-hover: $primary-color-highlight;
+
+    transition: background 500ms in_out_cubic, color 500ms in_out_cubic;
+}
+
+Body {
+    layout: horizontal;
+    height: 1fr;
+}
+
+Footer {
+    dock: bottom;
+    background: $primary-color;
+
+    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 {
+    color: $primary-color-accent;
+}
+
+LoadingIndicator.-textual-loading-indicator {
+    background: transparent;
+}

{pub_analyzer-0.1.0 → pub_analyzer-0.4.1}/pub_analyzer/css/report.tcss

@@ -71,6 +71,10 @@ LoadReportWidget .button-container {
 }
 
 /* Export Report Pane */
+ExportReportPane #export-form {
+    height: auto;
+}
+
 ExportReportPane .export-form-input-container {
     height: auto;
     margin-bottom: 2;
@@ -107,6 +111,12 @@ WorkModal #dialog .cards-container {
     grid-gutter: 1 2;
 }
 
+WorkModal #dialog .abstract {
+    height: auto;
+    width: 100%;
+    padding: 1 2;
+}
+
 WorkModal #dialog #tables-container {
     margin: 1 0;
 }

pub_analyzer-0.4.1/pub_analyzer/css/summary.tcss

@@ -0,0 +1,75 @@
+/* COLORS */
+$bg-main-color: white;
+$bg-secondary-color: #e5e7eb;
+$bg-secondary-color-accent: #d1d5db;
+$text-primary-color: black;
+
+$bg-main-color-darken: #1e293b;
+$bg-secondary-color-darken: #0f172a;
+$text-primary-color-darken: black;
+
+SummaryWidget {
+    height: 1fr;
+    margin: 1 2;
+
+    /* Titles */
+    .block-title {
+        text-align: center;
+        width: 100%;
+        border-bottom: solid $text-primary-color;
+    }
+
+    /* Block Container */
+    .block-container {
+        padding: 1;
+        height: auto;
+    }
+
+    /* Cards */
+    .cards-container {
+        height: auto;
+        margin: 1 0 0 0 ;
+
+        layout: grid;
+        grid-size: 3 1;
+        grid-rows: 14;
+        grid-columns: 1fr;
+        grid-gutter: 1 2;
+    }
+
+    /* Info Container */
+    .info-container {
+        height: auto;
+
+        Label {
+            text-align: center;
+            width: 1fr;
+        }
+    }
+
+    /* Table */
+    .table-container {
+        height: auto;
+        margin: 1 0 0 0;
+    }
+
+    /* Filter Container */
+    .filter-collapsible {
+        margin-top: 1;
+
+        DateRangeFilter {
+            margin-top: 1;
+        }
+    }
+
+    /* Buttons */
+    .button-container {
+        align: center middle;
+        height: 5;
+    }
+}
+
+.-dark-mode SummaryWidget {
+    color: $text-primary-color-darken;
+    background: $bg-secondary-color;
+}

{pub_analyzer-0.1.0 → pub_analyzer-0.4.1}/pub_analyzer/internal/identifier.py

@@ -1,11 +1,12 @@
 """Functions to extract OpenAlex IDs from Models."""
 
-from pub_analyzer.models.author import Author, AuthorResult, DehydratedAuthor
-from pub_analyzer.models.institution import DehydratedInstitution, Institution, InstitutionResult
+from pub_analyzer.models.author import Author, AuthorOpenAlexKey, AuthorResult, DehydratedAuthor
+from pub_analyzer.models.institution import DehydratedInstitution, Institution, InstitutionOpenAlexKey, InstitutionResult
+from pub_analyzer.models.source import DehydratedSource, Source
 from pub_analyzer.models.work import Work
 
 
-def get_author_id(author: Author | AuthorResult | DehydratedAuthor) -> str:
+def get_author_id(author: Author | AuthorResult | DehydratedAuthor) -> AuthorOpenAlexKey:
     """Extract OpenAlex ID from author Model.
 
     Args:
@@ -25,12 +26,12 @@ def get_author_id(author: Author | AuthorResult | DehydratedAuthor) -> str:
         ```
     """
     if author.id.path:
-        return author.id.path.rpartition('/')[2]
+        return author.id.path.rpartition("/")[2]
     else:
-        return ''
+        return ""
 
 
-def get_institution_id(institution: Institution | InstitutionResult | DehydratedInstitution) -> str:
+def get_institution_id(institution: Institution | InstitutionResult | DehydratedInstitution) -> InstitutionOpenAlexKey:
     """Extract OpenAlex ID from institution Model.
 
     Args:
@@ -50,9 +51,9 @@ def get_institution_id(institution: Institution | InstitutionResult | Dehydrated
         ```
     """
     if institution.id.path:
-        return institution.id.path.rpartition('/')[2]
+        return institution.id.path.rpartition("/")[2]
     else:
-        return ''
+        return ""
 
 
 def get_work_id(work: Work) -> str:
@@ -75,6 +76,31 @@ def get_work_id(work: Work) -> str:
         ```
     """
     if work.id.path:
-        return work.id.path.rpartition('/')[2]
+        return work.id.path.rpartition("/")[2]
     else:
-        return ''
+        return ""
+
+
+def get_source_id(source: DehydratedSource | Source) -> str:
+    """Extract OpenAlex ID from Source Model.
+
+    Args:
+        source: Source model instance.
+
+    Returns:
+        Source OpenAlex ID.
+
+    Example:
+        ```python
+        from pub_analyzer.internal.identifier import get_source_id
+        from pub_analyzer.models.source import Source
+
+        source = Source(id="https://openalex.org/S000000000", **kwargs)
+        print(get_source_id(source))
+        # 'S000000000'
+        ```
+    """
+    if source.id.path:
+        return source.id.path.rpartition("/")[2]
+    else:
+        return ""

{pub_analyzer-0.1.0 → pub_analyzer-0.4.1}/pub_analyzer/internal/render.py

@@ -30,7 +30,7 @@ async def render_template_report(report: AuthorReport | InstitutionReport) -> st
 
     # Render template
     env = Environment(loader=FileSystemLoader(searchpath=templates_path), enable_async=True, trim_blocks=True, lstrip_blocks=True)
-    return await env.get_template("report.typ").render_async(report=report, version=version('pub-analyzer'))
+    return await env.get_template("report.typ").render_async(report=report, version=version("pub-analyzer"))
 
 
 async def render_report(report: AuthorReport | InstitutionReport, file_path: pathlib.Path) -> bytes: