ssb-pubmd 0.1.1__tar.gz → 0.1.2__tar.gz

{ssb_pubmd-0.1.1 → ssb_pubmd-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ssb-pubmd
-Version: 0.1.1
+Version: 0.1.2
 Summary: SSB Pubmd
 License: MIT
 Author: Olav Landsverk

{ssb_pubmd-0.1.1 → ssb_pubmd-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-pubmd"
-version = "0.1.1"
+version = "0.1.2"
 description = "SSB Pubmd"
 authors = ["Olav Landsverk <stud-oll@ssb.no>"]
 license = "MIT"
@@ -9,6 +9,8 @@ homepage = "https://github.com/statisticsnorway/ssb-pubmd"
 repository = "https://github.com/statisticsnorway/ssb-pubmd"
 documentation = "https://statisticsnorway.github.io/ssb-pubmd"
 classifiers = ["Development Status :: 3 - Alpha"]
+include = ["ssb_pubmd/templates"]
+
 
 [tool.poetry.urls]
 Changelog = "https://github.com/statisticsnorway/ssb-pubmd/releases"

{ssb_pubmd-0.1.1 → ssb_pubmd-0.1.2}/ssb_pubmd/adapters/publish_client.py

@@ -44,13 +44,8 @@ class LocalTokenClient:
 
 
 class DaplaTokenClient:
-    token: str
-
-    def __init__(self) -> None:
-        self.token = AuthClient.fetch_personal_token(audiences=["ssbno"])
-
     def get_token(self) -> str:
-        return self.token
+        return AuthClient.fetch_personal_token(audiences=["ssbno"])
 
 class Response(NamedTuple):
     publish_path: str
@@ -111,14 +106,12 @@ class MimirPublishClient:
         )
 
 
-def get_publish_client(
-    config: Config, use_dapla_token_client: bool = False
-) -> PublishClient:
+def get_publish_client(config: Config) -> PublishClient:
     return MimirPublishClient(
         base_url=config.publish_base_url,
-        endpoint=config.publish_endpoint,
-        preview_base_path=config.publish_preview_base_path,
+        endpoint="/webapp/pubmd",
+        preview_base_path=config.publish_admin_path + "/site/preview/default/draft",
         token_client=DaplaTokenClient()
-        if use_dapla_token_client
+        if config.use_dapla_token_client
         else DEFULT_TOKEN_CLIENT,
     )

{ssb_pubmd-0.1.1 → ssb_pubmd-0.1.2}/ssb_pubmd/cli.py

@@ -1,9 +1,12 @@
 import subprocess
 import sys
+from importlib import resources
 from pathlib import Path
 
+from jinja2 import Template
 from watchfiles import watch
 
+from ssb_pubmd import templates
 from ssb_pubmd.adapters.content_parser import MimirContentParser
 from ssb_pubmd.adapters.document_processor import PandocDocumentProcessor
 from ssb_pubmd.adapters.publish_client import PublishClient
@@ -15,37 +18,58 @@ from ssb_pubmd.domain.document_publisher import sync_document
 
 def run_cli(system_arguments: list[str], config: Config) -> None:
     match system_arguments:
-        case [_, "preview", file_path]:
-            _preview(file_path, config)
+        case [_, "create", filename]:
+            _create_template(filename, config)
+        case [_, "preview", filename]:
+            _preview(filename, config)
         case _:
-            print("Usage: ssb-pubmd preview QUARTO_MARKDOWN_FILE")
+            print("Usage:")
+            print("  ssb-pubmd create FILENAME")
+            print("  ssb-pubmd preview FILENAME")
             sys.exit(1)
 
 
+def _create_template(filename: str, config: Config) -> None:
+    destination = Path.cwd() / filename
+    if destination.suffix != ".qmd":
+        print("The destination file path must have the '.qmd' extension.")
+        sys.exit(1)
+
+    with resources.open_text(templates, "template.qmd") as file:
+        raw_template = file.read()
+
+    rendered_template = Template(raw_template).render(
+        filepath=destination,
+        cms_admin_url=config.publish_base_url + config.publish_admin_path,
+        project_folder=destination.parent.name,
+        filename=destination.name,
+    )
+    destination.write_text(rendered_template)
+    print(
+        f"Successfully created template file {destination}.\n",
+        "Open the file for further instructions.",
+    )
+
+
 def _preview(file_path: str, config: Config) -> None:
     if Path(file_path).suffix != ".qmd":
         print("Only Quarto Markdown (.qmd) files are supported.")
         sys.exit(1)
-    try:
-        print("Fetching labid token...")
-        publish_client = get_publish_client(config, use_dapla_token_client=True)
-    except Exception:
-        print("Failed to fetch labid token; using environment variable...")
-        publish_client = get_publish_client(config, use_dapla_token_client=False)
+
+    publish_client = get_publish_client(config)
 
     _sync_updated_file(file_path, publish_client)
 
     print("Watching for file changes...")
     for changes in watch(file_path):
+        print("Found changes:")
+        print(changes)
         _sync_updated_file(file_path, publish_client)
 
 def _sync_updated_file(file_path: str, publish_client: PublishClient) -> None:
     print("Syncing updated document...")
-    try:
-        preview_url = _sync_quarto_file(file_path, publish_client)
-        print(f"Content synced successfully. Preview URL: {preview_url}")
-    except Exception as e:
-        print(f"Error during sync: {e}")
+    preview_url = _sync_quarto_file(file_path, publish_client)
+    print(f"Content synced successfully. Preview URL: {preview_url}")
 
 def _sync_quarto_file(file_path: str, publish_client: PublishClient) -> str:
     pandoc_document = _quarto_to_pandoc(file_path)

ssb_pubmd-0.1.2/ssb_pubmd/config.py

@@ -0,0 +1,37 @@
+"""App configuration through environment variables."""
+
+import os
+from dataclasses import dataclass
+from pathlib import Path
+
+
+@dataclass
+class Config:
+    publish_base_url: str
+    publish_admin_path: str
+    use_dapla_token_client: bool
+
+
+_TEST_CONFIG = Config(
+    publish_base_url="https://i.test.ssb.no",
+    publish_admin_path="/xp/admin",
+    use_dapla_token_client=True,
+)
+
+_LOCAL_CONFIG = Config(
+    publish_base_url="http://localhost:8080",
+    publish_admin_path="/admin",
+    use_dapla_token_client=False,
+)
+
+
+def get_config(metadata_file_path: Path | None = None) -> Config:
+    if os.environ.get("SSB_PUBMD_ENVIRONMENT") == "local":
+        config = _LOCAL_CONFIG
+    else:
+        config = _TEST_CONFIG
+
+    if os.environ.get("SSB_PUBMD_TOKEN_CLIENT") == "local":
+        config.use_dapla_token_client = False
+
+    return config

{ssb_pubmd-0.1.1 → ssb_pubmd-0.1.2}/ssb_pubmd/notebook_client.py

@@ -45,7 +45,10 @@ def configure_factbox(
     )
     _store_user_content(user_key=key, content=content)
 
-    md = _get_markdown_snippet(key, placeholder_text="Faktaboksens tekst skrives her.")
+    md = _get_markdown_snippet(
+        key,
+        placeholder_text="Faktaboksens tekst skrives her med Markdown-syntaks.\n\n### Underoverskrift\n\nNy paragraf.",
+    )
     print(md)
 
 

ssb_pubmd-0.1.2/ssb_pubmd/templates/template.qmd

@@ -0,0 +1,138 @@
+---
+ssb: 
+  path: /utdanning/grunnskoler/statistikk/elevar-i-grunnskolen/artikler
+  title: "Hovedtittel for artikkelen"
+  authors:
+      - name: Fornavn Etternavn
+        email: ---@ssb.no
+      - name: Fornavn Etternavn
+        email: ---@ssb.no
+  ingress: |
+      Ingress for artikkelen,
+      som kan skrives over flere linjer.
+---
+Dette er en SSB-artikkel skrevet med Quarto Markdown. 
+
+Neste steg:
+
+1. Sjekk at du er logget inn i CMS-et: {{ cms_admin_url }}/tool/com.enonic.app.contentstudio/main.
+
+2. Det er gitt et eksempel på CMS-mappe i feltet `path` ovenfor. Endre denne til CMS-mappen du ønsker å opprette artikkelen i. Dette må være en mappe du har skrivetilgang til.
+
+3. Kjør kommandoen `poetry run ssb-pubmd preview {{ filepath }}`. 
+   
+   * Dette vil opprette en draft-artikkel og printe URL'en til en forhåndsvisning av artikkelen. 
+   * Kommandoen fungerer tilsvarende som `quarto preview`, det vil si at forhåndsvisningen holdes oppdatert etter hvert som du endrer og lagrer denne filen.****
+   * Du må oppdatere nettleservinduet for å se endringene.
+  
+4. Les seksjonene nedenfor for en kort introduksjon til skriving av SSB-artikler i Quarto Markdown.
+
+## Artikkelmetadata
+
+Metadata-blokken øverst viser all metadata som kan settes for en artikkel.
+Dette er noe begrenset i testversjonen, men vil senere være komplett.
+Merk at `path` og `title` er obligatoriske felt.
+
+
+## Markdown
+
+Se [Quarto-referansen](https://quarto.org/docs/authoring/markdown-basics.html). Merk at:
+
+* Hovedoverskrift (`#`) støttes ikke, og skal settes i metadatablokken.
+
+## Kode
+
+Se [Quarto-referansen](https://quarto.org/docs/computations/python.html). Merk at: 
+
+* Ingen kodeblokker eller output vil komme med i artikkelen. 
+* [Kode i teksten](https://quarto.org/docs/computations/inline-code.html) støttes. Koden vil evalueres og erstattes med tekst før artikkelen sendes til CMS'et.
+* All kode må kunne kjøres fra topp til bunn.
+
+## SSB-komponenter
+
+I testversjonen tilbys et begrenset utvalg SSB-komponenter.
+Komponentene opprettes med Python og settes inn med Markdown.
+
+### Opprette komponenter
+
+Importér Python-pakken:
+
+```{python}
+import ssb_pubmd as ssb
+```
+
+Kodeblokkene nedenfor viser opprettelse av to komponenter; et highchart og en faktaboks:
+```{python}
+import pandas as pd
+data = {
+    "År": [
+        2000, 2001, 2002, 2003, 2004,
+        2005, 2006, 2007, 2008, 2009,
+        2010, 2011, 2012, 2013, 2014,
+        2015, 2016, 2017, 2018, 2019
+    ],
+    "Andel": [
+        4, 3.3, 4.7, 5.6, 7.2,
+        6.7, 7, 7.3, 7.6, 7.7,
+        7.7, 7.6, 8, 8.6, 9.4,
+        10, 10.3, 10.7, 11.3, 11.7
+    ]
+}
+df = pd.DataFrame(data)
+
+ssb.Highchart(
+    key="my-highchart",
+    title="Highchart title",
+    dataframe=df,
+    graph_type="line",
+    xlabel="my_xlabel",
+    ylabel="my_ylabel"
+)
+```
+
+```{python}
+ssb.Factbox(
+    key = "my-factbox",
+    title = "Factbox title",
+    display_type = "default")
+```
+
+Dokumentasjon: (link kommer).
+  * For å se alle funksjonene som tilbys, skriv `ssb.` på en kodelinje og tast `Ctrl + Space` (VSCode) eller `Tab` (Jupyterlab).
+  * VSCode: Dokumentasjonen til funksjonen vises automatisk i en popup-boks når man hovrer over funksjonen.
+
+### Sette inn komponenter
+
+Når du kjører en av kodeblokkene ovenfor, vil det printes en Markdown-snippet som kan kopieres og limes inn på en ny linje:
+
+::: { #my-highchart .ssb }
+:::
+
+Merk at faktabokser settes inn med innhold:
+
+::: { #my-factbox .ssb }
+
+Faktaboksens tekst skrives her med Markdown-syntaks.
+
+### Underoverskrift
+
+Ny paragraf.
+
+:::
+
+
+## Synkronisering
+
+Etter å ha synkronisert denne filen til CMS'et, vil du se en ekstra fil i Dapla-tjenesten:
+
+```
+{{ project_folder }}/
+├── {{ filename }}
+├── .ssbno.json
+```
+
+Metadatafilen `.ssbno.json` er automatisk generert og inneholder metadata for den tilhørende CMS-artikkelen. Merk at:
+
+* Dersom `.ssbno.json` slettes, vil en ny CMS-artikkel opprettes ved neste synkronisering.
+* Dersom man jobber med to separate SSB-artikler, skal disse ligge i hver sin mappe, slik at de har hver sin metadatafil.
+

ssb_pubmd-0.1.1/ssb_pubmd/config.py

@@ -1,23 +0,0 @@
-"""App configuration through environment variables."""
-
-import os
-from dataclasses import dataclass
-from pathlib import Path
-
-APP_NAME = "SSB_PUBMD"
-
-
-@dataclass
-class Config:
-    publish_base_url: str
-    publish_endpoint: str
-    publish_preview_base_path: str
-
-
-def get_config(metadata_file_path: Path | None = None) -> Config:
-    """Get config from enviromnent variables."""
-    return Config(
-        publish_base_url=os.environ[f"{APP_NAME}_BASE_URL"],
-        publish_endpoint=os.environ[f"{APP_NAME}_ENDPOINT"],
-        publish_preview_base_path=os.environ[f"{APP_NAME}_PREVIEW_BASE_PATH"],
-    )