ssb-pubmd 0.0.11__tar.gz → 0.0.13__tar.gz

{ssb_pubmd-0.0.11 → ssb_pubmd-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ssb-pubmd
-Version: 0.0.11
+Version: 0.0.13
 Summary: SSB Pubmd
 License: MIT
 Author: Olav Landsverk
@@ -55,43 +55,29 @@ Description-Content-Type: text/markdown
 
 - Supports logging in through a popup browser window.
 
-## Requirements
-
-- This library uses [playwright](https://github.com/microsoft/playwright-python) to create a logged in browser context. This requires installing a [browser binary](https://playwright.dev/python/docs/browsers#install-browsers) and necessary [system dependencies](https://playwright.dev/python/docs/browsers#install-system-dependencies).
 
 ## Installation
 
-You can install _SSB Pubmd_ via [pip] from [PyPI]:
+Installation with pip:
 
 ```console
 pip install ssb-pubmd
 ```
 
-## Usage
-
-First set environment variables:
+If you need to create a logged-in browser context, you will also need to install a [Playwright browser](https://playwright.dev/python/docs/browsers#install-browsers):
 
 ```console
-export PUBMD_LOGIN_URL=<https://www.example.com/login>
-export PUBMD_POST_URL=<https://www.example.com/post>
+playwright install --with-deps chromium`
 ```
 
-To log in, run:
-
-```console
-pubmd login
-```
-
-Close the popup browser window when you are logged in.
+## Usage
 
-To synchronize markdown content to the CMS server, run:
+Run the main command in a terminal to see available subcommands with documentation:
 
 ```console
-pubmd sync <file>
+pubmd
 ```
 
-`<file>` should be an absolute or relative path, and the allowed extensions are `.ipynb` and `md`.
-
 ## Contributing
 
 Contributions are very welcome.

{ssb_pubmd-0.0.11 → ssb_pubmd-0.0.13}/README.md

@@ -29,43 +29,29 @@
 
 - Supports logging in through a popup browser window.
 
-## Requirements
-
-- This library uses [playwright](https://github.com/microsoft/playwright-python) to create a logged in browser context. This requires installing a [browser binary](https://playwright.dev/python/docs/browsers#install-browsers) and necessary [system dependencies](https://playwright.dev/python/docs/browsers#install-system-dependencies).
 
 ## Installation
 
-You can install _SSB Pubmd_ via [pip] from [PyPI]:
+Installation with pip:
 
 ```console
 pip install ssb-pubmd
 ```
 
-## Usage
-
-First set environment variables:
+If you need to create a logged-in browser context, you will also need to install a [Playwright browser](https://playwright.dev/python/docs/browsers#install-browsers):
 
 ```console
-export PUBMD_LOGIN_URL=<https://www.example.com/login>
-export PUBMD_POST_URL=<https://www.example.com/post>
+playwright install --with-deps chromium`
 ```
 
-To log in, run:
-
-```console
-pubmd login
-```
-
-Close the popup browser window when you are logged in.
+## Usage
 
-To synchronize markdown content to the CMS server, run:
+Run the main command in a terminal to see available subcommands with documentation:
 
 ```console
-pubmd sync <file>
+pubmd
 ```
 
-`<file>` should be an absolute or relative path, and the allowed extensions are `.ipynb` and `md`.
-
 ## Contributing
 
 Contributions are very welcome.

{ssb_pubmd-0.0.11 → ssb_pubmd-0.0.13}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ssb-pubmd"
-version = "0.0.11"
+version = "0.0.13"
 description = "SSB Pubmd"
 authors = ["Olav Landsverk <stud-oll@ssb.no>"]
 license = "MIT"

ssb_pubmd-0.0.13/src/ssb_pubmd/__main__.py

@@ -0,0 +1,92 @@
+"""Command-line interface."""
+
+import json
+
+import click
+
+from ssb_pubmd.browser_context import BrowserRequestContext as RequestContext
+from ssb_pubmd.markdown_syncer import MarkdownSyncer
+
+CONFIG_FILE = "pubmd_config.json"
+
+
+class ConfigKeys:
+    """The keys used in the configuration file."""
+
+    LOGIN = "login_url"
+    POST = "post_url"
+
+
+def get_config_value(key: str) -> str:
+    """Get a configuration value."""
+    try:
+        with open(CONFIG_FILE) as json_file:
+            config = json.load(json_file)
+            value = config[key]
+    except FileNotFoundError:
+        click.echo(
+            f"Configuration file '{CONFIG_FILE}' not found. Please run the 'config' command first."
+        )
+    except Exception:
+        click.echo(
+            f"Error reading configuration file '{CONFIG_FILE}'. Please run the 'pubmd config' command again."
+        )
+    return str(value)
+
+
+@click.group()
+def cli() -> None:
+    """'pubmd' is a tool to sync markdown and notebook files to a CMS application.
+
+    Setup with subcommands 'config' and 'login', then use subcommand 'sync'.
+    """
+    pass
+
+
+@click.command()
+def config() -> None:
+    """Configure the CMS to connect to."""
+    login_url = click.prompt("Enter the login URL", type=str)
+    post_url = click.prompt("Enter the post URL", type=str)
+
+    config = {ConfigKeys.LOGIN: login_url, ConfigKeys.POST: post_url}
+
+    with open(CONFIG_FILE, "w") as json_file:
+        json.dump(config, json_file, indent=4)
+
+    click.echo(f"\nThe configuration has been stored in:\n{CONFIG_FILE}")
+
+
+@click.command()
+def login() -> None:
+    """Login to the CMS application."""
+    login_url = get_config_value(ConfigKeys.LOGIN)
+    request_context = RequestContext()
+    storage_state_file, storage_state = request_context.create_new(login_url)
+    click.echo(f"\nThe browser context has been stored in:\n{storage_state_file}")
+
+
+@click.command()
+@click.argument("content_file_path", type=click.Path())
+def sync(content_file_path: str) -> None:
+    """Sync a markdown or notebook file to the CMS."""
+    post_url = get_config_value(ConfigKeys.POST)
+    request_context = RequestContext()
+    request_context.recreate_from_file()
+
+    syncer = MarkdownSyncer(post_url=post_url, request_context=request_context)
+    syncer.content_file_path = content_file_path
+
+    content_id = syncer.sync_content()
+
+    click.echo(
+        f"File '{click.format_filename(content_file_path)}' synced to CMS with content ID: {content_id}"
+    )
+
+
+cli.add_command(config)
+cli.add_command(login)
+cli.add_command(sync)
+
+if __name__ == "__main__":
+    cli()  # pragma: no cover

{ssb_pubmd-0.0.11 → ssb_pubmd-0.0.13}/src/ssb_pubmd/browser_context.py

@@ -4,7 +4,7 @@ from playwright.sync_api import sync_playwright
 
 from .markdown_syncer import Response
 
-BROWSER_CONTEXT_FILE = "browser_context.json"
+BROWSER_CONTEXT_FILE = "pubmd_browser_context.json"
 
 
 class BrowserRequestContext:
@@ -52,11 +52,9 @@ class BrowserRequestContext:
         if self._context is None:
             raise ValueError("Browser context has not been created.")
 
-        # print(self._context.cookies(url))
-
         api_response = self._context.request.post(
             url,
-            data=data,
+            params=data,
         )
 
         try:

ssb_pubmd-0.0.11/src/ssb_pubmd/__main__.py

@@ -1,52 +0,0 @@
-"""Command-line interface."""
-
-import os
-
-import click
-
-from ssb_pubmd.browser_context import BrowserRequestContext as RequestContext
-from ssb_pubmd.markdown_syncer import MarkdownSyncer
-
-
-@click.group()
-def cli() -> None:
-    """Command-line interface for the ssb_pubmd package."""
-    pass
-
-
-@click.command()
-def login() -> None:
-    """Login to the server."""
-    login_url = os.getenv("PUBMD_LOGIN_URL", "")
-    request_context = RequestContext()
-    print(login_url)
-    storage_state_file, storage_state = request_context.create_new(login_url)
-    click.echo(
-        f"The following browser context object is now stored in {storage_state_file}:"
-    )
-    click.echo(storage_state)
-
-
-@click.command()
-@click.argument("content_file_path", type=click.Path())
-def sync(content_file_path: str) -> None:
-    """Sync the content."""
-    post_url = os.getenv("PUBMD_POST_URL", "")
-    request_context = RequestContext()
-    request_context.recreate_from_file()
-
-    syncer = MarkdownSyncer(post_url=post_url, request_context=request_context)
-    syncer.content_file_path = content_file_path
-
-    content_id = syncer.sync_content()
-
-    click.echo(
-        f"File '{click.format_filename(content_file_path)}' synced to CMS with content ID: {content_id}"
-    )
-
-
-cli.add_command(login)
-cli.add_command(sync)
-
-if __name__ == "__main__":
-    cli()  # pragma: no cover