Make creating extensions easier via CLI #22, v0.3.2

Author: m-mohr

CHANGELOG.md

@@ -9,7 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- ...
+- `fiboa rename-extension` to quickly replace template placeholders in new extensions
 
 ### Changed
 
@@ -27,6 +27,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - ...
 
+## [v0.3.2] - 2024-04-12
+
+### Added
+
+- `fiboa rename-extension` to quickly replace template placeholders in new extensions
+
 ## [v0.3.1] - 2024-04-11
 
 ### Added
@@ -130,7 +136,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - First release
 
-[Unreleased]: <https://github.com/fiboa/cli/compare/v0.3.1...main>
+[Unreleased]: <https://github.com/fiboa/cli/compare/v0.3.2...main>
+[v0.3.2]: <https://github.com/fiboa/cli/compare/v0.3.1...v0.3.2>
 [v0.3.1]: <https://github.com/fiboa/cli/compare/v0.3.0...v0.3.1>
 [v0.3.0]: <https://github.com/fiboa/cli/compare/v0.2.1...v0.3.0>
 [v0.2.1]: <https://github.com/fiboa/cli/compare/v0.2.0...v0.2.1>

README.md

@@ -77,6 +77,23 @@ To validate a fiboa Schema YAML file, you can for example run:
 
 Check `fiboa validate-schema --help` for more details.
 
+## Update an extension template with new names
+
+Once you've created and git cloned a new extension, you can use the CLI
+to update all template placeholders with proper names.
+
+For example, if your extension is meant to have
+- the title "Timestamps Extension", 
+- the prefix `ts` (e.g. field `ts:created` or `ts:updated`),
+- is hosted at `https://github.io/fiboa/timestamps-extension`
+  (organization: `fiboa`, repository `timestamps-extension`),
+- and you run fiboa in the folder of the extension.
+
+Then the following command could be used:
+- `fiboa rename-extension . -t Timestamps -p ts -s timestamps-extension -o fiboa`
+
+Check `fiboa rename-extension --help` for more details.
+
 ## Converter for existing datasets
 
 To convert an existing dataset to fiboa using the pre-defined converters:

fiboa_cli/__init__.py

@@ -8,10 +8,11 @@
 from .create_geojson import create_geojson as create_geojson_
 from .describe import describe as describe_
 from .jsonschema import jsonschema as jsonschema_
+from .rename_extension import rename_extension as rename_extension_
 from .validate import validate as validate_
 from .validate_schema import validate_schema as validate_schema_
 from .version import __version__, fiboa_version as fiboa_version_
-from .util import log, check_ext_schema_for_cli, valid_file_for_cli, valid_file_for_cli_with_ext, valid_files_folders_for_cli
+from .util import log, check_ext_schema_for_cli, valid_file_for_cli, valid_file_for_cli_with_ext, valid_files_folders_for_cli, valid_folder_for_cli
 
 @click.group()
 @click.version_option(version=__version__)
@@ -304,13 +305,53 @@ def convert(dataset, out, cache, source_coop, collection):
         sys.exit(1)
 
 
+## RENAME EXTENSION
+@click.command()
+@click.argument('folder', nargs=1, callback=valid_folder_for_cli)
+@click.option(
+    '--title', '-t',
+    type=click.STRING,
+    help='Title of the extension, e.g. `Timestamps`',
+    required=True
+)
+@click.option(
+    '--slug', '-s',
+    type=click.STRING,
+    help='Slug of the repository, e.g. for `https://github.com/fiboa/timestamps-extension` it would be `timestamps-extension`',
+    required=True
+)
+@click.option(
+    '--org', '-o',
+    type=click.STRING,
+    help='Slug of the GitHub Organization. Defaults to `fiboa`',
+    default="fiboa"
+)
+@click.option(
+    '--prefix', '-p',
+    type=click.STRING,
+    help='Prefix for the field, e.g. `time` if the fields should be `time:created` or `time:updated`. An empty string removed the prefix, not providing a prefix leaves it as is.',
+    default=None
+)
+def rename_extension(folder, title, slug, org = "fiboa", prefix = None):
+    """
+    Updates placeholders in an extension folder to the new name.
+    """
+    log(f"fiboa CLI {__version__} - Rename placeholders in extensions\n", "success")
+    try:
+        rename_extension_(folder, title, slug, gh_org=org, prefix=prefix)
+    except Exception as e:
+        log(e, "error")
+        sys.exit(1)
+
+
 cli.add_command(describe)
 cli.add_command(validate)
 cli.add_command(validate_schema)
 cli.add_command(create_geoparquet)
 cli.add_command(create_geojson)
 cli.add_command(jsonschema)
 cli.add_command(convert)
+cli.add_command(rename_extension)
 
 if __name__ == '__main__':
     cli()

fiboa_cli/rename_extension.py

@@ -0,0 +1,100 @@
+import os
+import re
+
+from .util import log
+from .create_geoparquet import create_geoparquet
+
+def replace_in_str(content, search, replace):
+    if isinstance(search, list) and isinstance(replace, list) and len(search) != len(replace):
+        raise ValueError("Search and replace lists must have the same length")
+
+    if isinstance(search, str):
+        return content.replace(search, replace)
+    elif isinstance(search, re.Pattern):
+        return content.replace(search, replace)
+    elif isinstance(search, list) and isinstance(replace, list):
+        for s, r in zip(search, replace):
+            content = replace_in_str(content, s, r)
+        return content
+    elif isinstance(search, list):
+        for s in search:
+            content = replace_in_str(content, s, replace)
+        return content
+    else:
+        raise ValueError(f"Invalid search type: {type(search)}")
+
+def replace_in_file(file, search, replace):
+    try:
+        with open(file, "r+") as f:
+            content = f.read()
+            content = replace_in_str(content, search, replace)
+            f.seek(0)
+            f.write(content)
+            f.truncate()
+        log(f"Updated {file}", "success")
+    except Exception as e:
+        log(f"Can't update {file}: {e}", "error")
+
+def rename_extension(folder, title, slug, gh_org = "fiboa", prefix = None):
+    if prefix is None:
+        prefix = "template"
+
+    README = os.path.join(folder, "README.md")
+    CHANGELOG = os.path.join(folder, "CHANGELOG.md")
+    PIPFILE = os.path.join(folder, "Pipfile")
+    JSON_COLLECTION = os.path.join(folder, "examples/geojson/collection.json")
+    GEOJSON_FEATURE = os.path.join(folder, "examples/geojson/example.json")
+    GEOPARQUET = os.path.join(folder, "examples/geoparquet/example.parquet")
+    SCHEMA = os.path.join(folder, "schema/schema.yaml")
+
+    if prefix == "":
+        PREFIX_CODE = ""
+        PREFIX_TITLE = "none"
+    else:
+        PREFIX_CODE = f"{prefix}:"
+        PREFIX_TITLE = prefix
+
+    GH_SEARCH = [
+        "/extension-template/",
+        "fiboa.github.io"
+    ]
+    GH_REPLACE = [
+        f"/{slug}/",
+        f"{gh_org}.github.io"
+    ]
+    replace_in_file(PIPFILE, GH_SEARCH, GH_REPLACE)
+    replace_in_file(JSON_COLLECTION, GH_SEARCH, GH_REPLACE)
+
+    replace_in_file(CHANGELOG, "/fiboa/extension-template/", f"/{gh_org}/{slug}/")
+
+    PREFIX_SEARCH = "template:"
+    replace_in_file(GEOJSON_FEATURE, PREFIX_SEARCH, PREFIX_CODE)
+    replace_in_file(SCHEMA, PREFIX_SEARCH, PREFIX_CODE)
+
+    README_SEARCH = GH_SEARCH + [
+        "Template Extension",
+        "- **Title:** Template",
+        "- **Property Name Prefix:** template",
+        "| template:"
+    ]
+    README_REPLACE = GH_REPLACE + [
+        f"{title} Extension",
+        f"- **Title:** {title}",
+        f"- **Property Name Prefix:** {PREFIX_TITLE}",
+        f"| {PREFIX_CODE}"
+    ]
+    replace_in_file(README, README_SEARCH, README_REPLACE)
+
+    try:
+        config = {
+            "files": [GEOJSON_FEATURE],
+            "out": GEOPARQUET,
+            "schema": None,
+            "collection": JSON_COLLECTION,
+            "extension_schemas": {
+                f"https://{gh_org}.github.io/{slug}/v0.1.0/schema.yaml": SCHEMA
+            }
+        }
+        create_geoparquet(config)
+    except Exception as e:
+        log(f"Can't update {GEOPARQUET}: {e}", "error")

fiboa_cli/util.py

@@ -192,6 +192,14 @@ def valid_file_for_cli_with_ext(value, extensions):
     return is_valid_file_uri(value, extensions)
 
 
+def valid_folder_for_cli(ctx, param, value):
+    """Determine if the input is a folder."""
+    if os.path.exists(value) and os.path.isdir(value):
+        return value
+    else:
+        raise click.BadParameter('Input must be an existing local folder')
+
+
 def get_collection(data, collection_path = None, basepath = None):
     # If the user provided a collection, enforce using it
     if collection_path is not None:

fiboa_cli/version.py

@@ -1,2 +1,2 @@
-__version__ = "0.3.1"
+__version__ = "0.3.2"
 fiboa_version = "0.2.0"