merge branch develop

Author: deeleeramone

.codespell.skip

@@ -17,6 +17,7 @@
 ./build/pyinstaller
 ./**/node_modules
 ./frontend-components/**
+./cookiecutter/**
 ./openbb_platform/providers/econdb/openbb_econdb/utils/helpers.py
 ./openbb_platform/core/openbb/package/**
 ./openbb_platform/providers/imf/openbb_imf/utils/constants.py

.coveragerc

@@ -4,4 +4,5 @@ omit =
     tests/*
     **/tests/**
     **/package/**
+    cookiecutter/**
 source = .

.pylintrc

@@ -1,14 +1,12 @@
 [MASTER]
-
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=CVS,cookiecutter
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code
 extension-pkg-allow-list=math,binascii
 
-# Add files or directories to the blacklist. They should be base names, not
-# paths.
-ignore=CVS
-
 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
 ignore-patterns=

cookiecutter/MANIFEST.in

@@ -0,0 +1,5 @@
+include README.md
+include LICENSE
+recursive-include openbb_cookiecutter/template *
+recursive-exclude openbb_cookiecutter/template *.pyc
+recursive-exclude openbb_cookiecutter/template __pycache__

cookiecutter/README.md

@@ -0,0 +1,72 @@
+# OpenBB ODP Extensions Cookiecutter
+
+[Cookiecutter](https://cookiecutter.readthedocs.io/en/1.7.2/) is a command-line utility that creates projects from templates.
+
+This extension is a simple template for setting up new OpenBB Python Package extensions and projects.
+
+## Template Structure
+
+The Cookiecutter template prompts the user for information to use in the `pyproject.toml` file, and then generates a project based on that information.
+All fields are optional.
+
+- Your Name
+- Your Email
+- Project Name
+- Project Tag (some-distributable-package)
+- Package Name ("include" code folder name - "some_package")
+- Provider Name - name of the provider for the entry point - i.e, 'fmp'
+- Router Name - name of the router path - i.e. `obb.{some_package}`
+- OBBject Name - name of the OBBject accessor namespace.
+
+The template will generate all extension types as a single, installable Python project.
+You likely won't always use all in tandem, just delete the unwanted folders and entrypoints.
+
+## Usage
+
+1. Install in a Python environment from PyPI with:
+
+```
+pip install openbb-cookiecutter
+```
+
+Alternatively, with `uvx`:
+
+```
+uvx openbb-cookiecutter
+```
+
+2. Navigate the current working directory to the desired output location and run:
+
+```
+openbb-cookiecutter
+```
+
+Enter values or press `enter` to continue with the default.
+
+3. Create a new Python environment for the project.
+
+4. Navigate into the generated folder and install with:
+
+```
+pip install -e .
+```
+
+5. Python static files will be generated on first import, or trigger with `openbb-build`.
+
+6. Import the Python package or start the API and use like any other OpenBB application.
+
+7. Modify the business logic and get started building!
+
+See the developer documentation [here](https://docs.openbb.co/python/developer).
+
+## Contributing
+
+We welcome contributions to this template! Please feel free to open an issue or submit a pull request with your improvements.
+
+## Contacts
+
+If you have any questions about the cookiecutter or anything OpenBB, feel free to email us at `[email protected]`
+
+If you want to say hi, or are interested in partnering with us, feel free to reach us at `[email protected]`
+
+Any of our social media platforms: [openbb.co/links](https://openbb.co/links)

cookiecutter/cookiecutter.json

@@ -0,0 +1,8 @@
+{
+  "full_name": "Super Quant",
+  "email": "[email protected]",
+  "project_name": "Super Quant",
+  "project_tag": "{{ cookiecutter.project_name.lower().replace(' ', '-') }}",
+  "package_name": "{{ cookiecutter.project_name.lower().replace(' ', '_') }}",
+  "_template": "{% now 'utc', '%Y%m%d%H%M%S' %}"
+}

cookiecutter/openbb_cookiecutter/__init__.py

@@ -0,0 +1,10 @@
+"""OpenBB Cookiecutter Template."""
+
+from pathlib import Path
+
+__version__ = "0.4.0"
+
+
+def get_template_path() -> Path:
+    """Return the path to the cookiecutter template directory."""
+    return Path(__file__).parent / "template"

cookiecutter/openbb_cookiecutter/cli.py

@@ -0,0 +1,76 @@
+"""CLI for OpenBB Cookiecutter template."""
+
+# pylint: disable=W0718
+
+import argparse
+import sys
+
+from cookiecutter.main import cookiecutter
+
+from . import get_template_path
+
+
+def main(argv: list | None = None) -> int:
+    """Run the OpenBB cookiecutter template.
+
+    Args:
+        argv: Command line arguments (defaults to sys.argv[1:])
+
+    Returns:
+        Exit code (0 for success, non-zero for error)
+    """
+    parser = argparse.ArgumentParser(
+        description="Generate an OpenBB Platform extension from template"
+    )
+    parser.add_argument(
+        "-o",
+        "--output-dir",
+        default=".",
+        help="Where to output the generated project (default: current directory)",
+    )
+    parser.add_argument(
+        "--no-input",
+        action="store_true",
+        help="Do not prompt for parameters and use defaults",
+    )
+    parser.add_argument(
+        "-f", "--overwrite-if-exists", action="store_true", help="Overwrite if exists"
+    )
+    parser.add_argument(
+        "--extra-context",
+        action="append",
+        metavar="KEY=VALUE",
+        help="Extra context variables (can be used multiple times)",
+    )
+
+    args = parser.parse_args(argv)
+
+    # Build extra context from arguments
+    extra_context = {}
+    if args.extra_context:
+        for item in args.extra_context:
+            if "=" not in item:
+                print(f"Error: extra-context must be in KEY=VALUE format: {item}")
+                return 1
+            key, value = item.split("=", 1)
+            extra_context[key] = value
+
+    # Get the bundled template path
+    template_path = get_template_path()
+
+    try:
+        cookiecutter(
+            str(template_path),
+            output_dir=args.output_dir,
+            no_input=args.no_input,
+            overwrite_if_exists=args.overwrite_if_exists,
+            extra_context=extra_context if extra_context else None,
+        )
+        return 0
+    except Exception as e:
+        print(f"Error: {e}", file=sys.stderr)  # noqa
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())

cookiecutter/openbb_cookiecutter/template/cookiecutter.json

@@ -0,0 +1,11 @@
+{
+  "full_name": "Hello World",
+  "email": "[email protected]",
+  "project_name": "OpenBB Python Extension Template",
+  "project_tag": "extension-template",
+  "package_name": "extension_template",
+  "provider_name": "template",
+  "router_name": "template",
+  "obbject_name": "template",
+  "_template": "{% now 'utc', '%Y%m%d%H%M%S' %}"
+}

cookiecutter/openbb_cookiecutter/template/hooks/post_gen_project.py

@@ -0,0 +1,31 @@
+"""OpenBB Platform Extension post-generation script."""
+
+import re
+import sys
+
+MODULE_REGEX = r"^[_a-zA-Z][_a-zA-Z0-9]+$"
+
+MODULE_NAME = "{{ cookiecutter.package_name }}"
+PROVIDER_NAME = "{{ cookiecutter.provider_name }}" or ""
+ROUTER_NAME = "{{ cookiecutter.router_name }}" or ""
+OBBJECT_NAME = "{{ cookiecutter.obbject_name }}" or ""
+
+if not re.match(MODULE_REGEX, MODULE_NAME):
+    print(f"ERROR: {MODULE_NAME} is not a valid Python package name.")
+
+    sys.exit(1)
+
+if PROVIDER_NAME and not re.match(MODULE_REGEX, PROVIDER_NAME):
+    print(f"ERROR: {PROVIDER_NAME} should be in lower snakecase.")
+
+    sys.exit(1)
+
+if ROUTER_NAME and not re.match(MODULE_REGEX, ROUTER_NAME):
+    print(f"ERROR: {ROUTER_NAME} should be in lower snakecase.")
+
+    sys.exit(1)
+
+if OBBJECT_NAME and not re.match(MODULE_REGEX, OBBJECT_NAME):
+    print(f"ERROR: {OBBJECT_NAME} should be in lower snakecase.")
+
+    sys.exit(1)