ssb-pubmd 0.0.12__py3-none-any.whl → 0.0.13__py3-none-any.whl

ssb_pubmd/__main__.py

@@ -1,37 +1,76 @@
 """Command-line interface."""
 
-import os
+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:
-    """Command-line interface for the ssb_pubmd package."""
+    """'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 server."""
-    login_url = os.getenv("PUBMD_LOGIN_URL", "")
+    """Login to the CMS application."""
+    login_url = get_config_value(ConfigKeys.LOGIN)
     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.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 the content."""
-    post_url = os.getenv("PUBMD_POST_URL", "")
+    """Sync a markdown or notebook file to the CMS."""
+    post_url = get_config_value(ConfigKeys.POST)
     request_context = RequestContext()
     request_context.recreate_from_file()
 
@@ -45,6 +84,7 @@ def sync(content_file_path: str) -> None:
     )
 
 
+cli.add_command(config)
 cli.add_command(login)
 cli.add_command(sync)
 

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:

{ssb_pubmd-0.0.12.dist-info → ssb_pubmd-0.0.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ssb-pubmd
-Version: 0.0.12
+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.13.dist-info/RECORD

@@ -0,0 +1,10 @@
+ssb_pubmd/__init__.py,sha256=WD-U43QQTQIRSRgTHSnEjcG5MuH4T_CPFHPXols2NLk,179
+ssb_pubmd/__main__.py,sha256=a99fscfnw6rr2fOG4KFsCzZnSzo2eo94xpX7vyLImV8,2611
+ssb_pubmd/browser_context.py,sha256=zNT-YehZh00uG8f4KGr3KbXIFOE84_7Ky4HjOmxN4zs,2350
+ssb_pubmd/markdown_syncer.py,sha256=RHP3bHIGPRLichrleygOS2WIVN1KOlYPehbrcenJMRk,7631
+ssb_pubmd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ssb_pubmd-0.0.13.dist-info/LICENSE,sha256=tF5bnYv09fgH5ph9t1EpH1MGrVOGTQeswL4dzVeZ_ak,1073
+ssb_pubmd-0.0.13.dist-info/METADATA,sha256=P05Hv5mkPm8z0dF63GMhfE7PZdUr4u8uWylv-WvvXWU,4208
+ssb_pubmd-0.0.13.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
+ssb_pubmd-0.0.13.dist-info/entry_points.txt,sha256=1_NfsiOfqTg948JWXYPwi4QtDk90KHkNn1CQtye8rJ0,48
+ssb_pubmd-0.0.13.dist-info/RECORD,,

ssb_pubmd-0.0.12.dist-info/RECORD

@@ -1,10 +0,0 @@
-ssb_pubmd/__init__.py,sha256=WD-U43QQTQIRSRgTHSnEjcG5MuH4T_CPFHPXols2NLk,179
-ssb_pubmd/__main__.py,sha256=WdiICEorWrTbM1NDIkG-97Gg49IV5Pm_MBkQHr3Scec,1364
-ssb_pubmd/browser_context.py,sha256=JXDlvUJZ-NYLQlE0_MRAiuRxGrMVBfvm5Rt2QX7dYRA,2344
-ssb_pubmd/markdown_syncer.py,sha256=RHP3bHIGPRLichrleygOS2WIVN1KOlYPehbrcenJMRk,7631
-ssb_pubmd/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ssb_pubmd-0.0.12.dist-info/LICENSE,sha256=tF5bnYv09fgH5ph9t1EpH1MGrVOGTQeswL4dzVeZ_ak,1073
-ssb_pubmd-0.0.12.dist-info/METADATA,sha256=6YfXG5dXzW-2xU-Cdbtik5-ophdBRngUsSbBJ_DVYkw,4707
-ssb_pubmd-0.0.12.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-ssb_pubmd-0.0.12.dist-info/entry_points.txt,sha256=1_NfsiOfqTg948JWXYPwi4QtDk90KHkNn1CQtye8rJ0,48
-ssb_pubmd-0.0.12.dist-info/RECORD,,