djrocket 1.0.0a2__tar.gz

djrocket-1.0.0a2/LICENSE.md

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2023 Ernesto González
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

djrocket-1.0.0a2/MANIFEST.in

@@ -0,0 +1,5 @@
+recursive-include djangorocket/templates *
+
+# setup.py's build_py runs this script to zip each template, so the wheel cannot
+# be built from the sdist without it.
+include tools/zip_templates.py

djrocket-1.0.0a2/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: djrocket
+Version: 1.0.0a2
+Summary: CLI tool to add applications and UI templates to any Django website.
+Home-page: https://github.com/ernestofgonzalez/djangorocket
+Author: Ernesto González
+License: Apache License, Version 2.0
+Project-URL: Documentation, https://djangorocket.com/
+Project-URL: Changelog, https://djangorocket.com/changelog.html
+Project-URL: Source code, https://github.com/ernestofgonzalez/djangorocket
+Project-URL: Issues, https://github.com/ernestofgonzalez/djangorocket/issues
+Project-URL: CI, https://github.com/ernestofgonzalez/djangorocket/actions
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Framework :: Django :: 5.0
+Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: click
+Requires-Dist: click-default-group>=1.2.3
+Requires-Dist: cookiecutter
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# djangorocket
+
+[![Django version](https://img.shields.io/badge/django-5.2.17-blue)](https://github.com/ErnestoFGonzalez/djangorocket)
+[![Latest Release](https://img.shields.io/github/v/release/ErnestoFGonzalez/djangorocket)](https://github.com/ErnestoFGonzalez/djangorocket/releases)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/ErnestoFGonzalez/djangorocket/blob/main/LICENSE.md)
+
+_Django Rocket is a powerful Django SaaS boilerplate designed for indie hackers and SaaS companies that need to quickly launch their paywalled software. It leverages the [Cookiecutter](https://github.com/cookiecutter/cookiecutter) templating engine to generate a project structure with commonly used features such as authentication and billing, saving you time and effort_.
+
+For detailed information on usage and third-party integrations, please refer to the [full documentation](https://djangorocket.com).
+
+## Features
+
+- Custom user model with login, registration, and account, email and security settings pages
+- Stripe subscriptions via [stripe-python](https://github.com/stripe/stripe-python), with checkout, cancel and reactivate flows and a webhook endpoint
+- Customizable templates with [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) (powered by [django-tailwind](https://github.com/timonweb/django-tailwind))
+- A REST API with token and API-key authentication, via [djangorestframework](https://github.com/encode/django-rest-framework)
+- Search backed by OpenSearch, and background work with [celery](https://github.com/celery/celery) on Redis
+- Postgres and Redis defined in `docker-compose.yml`, on host ports picked free on your machine
+- Static file serving with [whitenoise](https://github.com/evansd/whitenoise)
+
+## Installation
+
+Install the CLI with [pip](https://github.com/pypa/pip):
+
+```bash
+$ pip install djrocket
+```
+
+> **_NOTE:_** The package is published as `djrocket`; the command it installs is `djangorocket`.
+
+Generating and running a project needs:
+
+- **Python 3.10 - 3.14**
+- **Docker**, to run the Postgres and Redis services the generated project comes with
+
+## Usage
+
+To create a new Django Rocket project, run the following command in your terminal:
+
+```bash
+$ djangorocket init
+```
+
+You will be prompted for your project name, after which the project structure will be generated. Scaffolding writes a working `.env` for you — a fresh `SECRET_KEY`, throwaway Postgres credentials and free host ports — so there is nothing to fill in before booting locally.
+
+One command then takes the new project to a running app, creating a virtualenv, installing the dependencies, starting Postgres and Redis, and applying the migrations:
+
+```bash
+$ make bootstrap
+$ make runserver
+```
+
+Each generated project ships a README covering its layout, every `make` target, the Tailwind workflow and what to set when deploying.
+
+### Adding UI templates
+
+To add a UI component to an existing Django Rocket project, run `add` from the project root:
+
+```bash
+$ djangorocket add accordion
+```
+
+### Using cookiecutter directly
+
+Django Rocket is also usable as a plain Cookiecutter template, without installing the CLI:
+
+```bash
+$ pip install cookiecutter==2.1.1
+$ cookiecutter gh:ErnestoFGonzalez/djangorocket --directory="djangorocket/templates/projects/base"
+```
+
+> **_NOTE:_** Although Django Rocket works with other versions of Cookiecutter, we recommend the version mentioned above, as it is the one that's well-tested.
+
+For comprehensive coverage of features and integrations, check out the [full documentation](https://djangorocket.com).

djrocket-1.0.0a2/README.md

@@ -0,0 +1,74 @@
+# djangorocket
+
+[![Django version](https://img.shields.io/badge/django-5.2.17-blue)](https://github.com/ErnestoFGonzalez/djangorocket)
+[![Latest Release](https://img.shields.io/github/v/release/ErnestoFGonzalez/djangorocket)](https://github.com/ErnestoFGonzalez/djangorocket/releases)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/ErnestoFGonzalez/djangorocket/blob/main/LICENSE.md)
+
+_Django Rocket is a powerful Django SaaS boilerplate designed for indie hackers and SaaS companies that need to quickly launch their paywalled software. It leverages the [Cookiecutter](https://github.com/cookiecutter/cookiecutter) templating engine to generate a project structure with commonly used features such as authentication and billing, saving you time and effort_.
+
+For detailed information on usage and third-party integrations, please refer to the [full documentation](https://djangorocket.com).
+
+## Features
+
+- Custom user model with login, registration, and account, email and security settings pages
+- Stripe subscriptions via [stripe-python](https://github.com/stripe/stripe-python), with checkout, cancel and reactivate flows and a webhook endpoint
+- Customizable templates with [Tailwind CSS](https://github.com/tailwindlabs/tailwindcss) (powered by [django-tailwind](https://github.com/timonweb/django-tailwind))
+- A REST API with token and API-key authentication, via [djangorestframework](https://github.com/encode/django-rest-framework)
+- Search backed by OpenSearch, and background work with [celery](https://github.com/celery/celery) on Redis
+- Postgres and Redis defined in `docker-compose.yml`, on host ports picked free on your machine
+- Static file serving with [whitenoise](https://github.com/evansd/whitenoise)
+
+## Installation
+
+Install the CLI with [pip](https://github.com/pypa/pip):
+
+```bash
+$ pip install djrocket
+```
+
+> **_NOTE:_** The package is published as `djrocket`; the command it installs is `djangorocket`.
+
+Generating and running a project needs:
+
+- **Python 3.10 - 3.14**
+- **Docker**, to run the Postgres and Redis services the generated project comes with
+
+## Usage
+
+To create a new Django Rocket project, run the following command in your terminal:
+
+```bash
+$ djangorocket init
+```
+
+You will be prompted for your project name, after which the project structure will be generated. Scaffolding writes a working `.env` for you — a fresh `SECRET_KEY`, throwaway Postgres credentials and free host ports — so there is nothing to fill in before booting locally.
+
+One command then takes the new project to a running app, creating a virtualenv, installing the dependencies, starting Postgres and Redis, and applying the migrations:
+
+```bash
+$ make bootstrap
+$ make runserver
+```
+
+Each generated project ships a README covering its layout, every `make` target, the Tailwind workflow and what to set when deploying.
+
+### Adding UI templates
+
+To add a UI component to an existing Django Rocket project, run `add` from the project root:
+
+```bash
+$ djangorocket add accordion
+```
+
+### Using cookiecutter directly
+
+Django Rocket is also usable as a plain Cookiecutter template, without installing the CLI:
+
+```bash
+$ pip install cookiecutter==2.1.1
+$ cookiecutter gh:ErnestoFGonzalez/djangorocket --directory="djangorocket/templates/projects/base"
+```
+
+> **_NOTE:_** Although Django Rocket works with other versions of Cookiecutter, we recommend the version mentioned above, as it is the one that's well-tested.
+
+For comprehensive coverage of features and integrations, check out the [full documentation](https://djangorocket.com).

djrocket-1.0.0a2/djangorocket/__main__.py

@@ -0,0 +1,4 @@
+from djangorocket.cli import main
+
+if __name__ == "__main__":
+    main(prog_name="djangorocket")

djrocket-1.0.0a2/djangorocket/cli.py

@@ -0,0 +1,212 @@
+import contextlib
+import importlib.resources
+import itertools
+import os
+import re
+import socket
+import subprocess
+import sys
+import threading
+import time
+
+import click
+from cookiecutter.main import cookiecutter
+from cookiecutter.exceptions import OutputDirExistsException
+
+from djangorocket.components import add_components
+from djangorocket.django import DjangoSettingsManager
+
+@click.group()
+def main():
+    pass
+
+
+@contextlib.contextmanager
+def _spinner(message):
+    """Show an animated 'working' indicator while a slow step runs.
+
+    Generating a project renders well over a hundred files with no output of its
+    own, which makes the command look hung. This keeps the terminal alive with a
+    spinner on a TTY, and falls back to a single plain line otherwise (e.g. when
+    output is piped or running in CI).
+    """
+    if not sys.stderr.isatty():
+        click.echo(message, err=True)
+        yield
+        return
+
+    done = threading.Event()
+
+    def spin():
+        for frame in itertools.cycle("|/-\\"):
+            if done.is_set():
+                break
+            click.echo(f"\r{frame} {message}", nl=False, err=True)
+            time.sleep(0.1)
+        click.echo("\r\033[K", nl=False, err=True)  # clear the spinner line
+
+    thread = threading.Thread(target=spin)
+    thread.start()
+    try:
+        yield
+    finally:
+        done.set()
+        thread.join()
+
+
+def _slugify_dirname(project_name):
+    """Kebab-case a project name for use as a directory / docker identifier."""
+    slug = re.sub(r"[^a-z0-9]+", "-", project_name.lower()).strip("-")
+    return slug or "project"
+
+
+def _existing_docker_volume_names():
+    """Names of existing docker volumes, or empty set when docker is unavailable."""
+    try:
+        result = subprocess.run(
+            ["docker", "volume", "ls", "--format", "{{.Name}}"],
+            capture_output=True,
+            text=True,
+            timeout=10,
+            check=True,
+        )
+    except (OSError, subprocess.SubprocessError):
+        return set()
+    return set(result.stdout.split())
+
+
+def _available_project_dirname(base, output_dir, taken_volumes):
+    """First of ``base``, ``base-1``, ``base-2``, ... free on disk and in docker.
+
+    A generated project's docker-compose names its volumes ``<dirname>_postgres_data``
+    and ``<dirname>_redis_data``, so we also skip a name whose volumes already exist
+    even when the directory does not (e.g. a previous project was removed but its
+    data volumes lingered).
+    """
+
+    def is_taken(name):
+        if os.path.exists(os.path.join(output_dir, name)):
+            return True
+        return any(
+            "{0}_{1}".format(name, suffix) in taken_volumes
+            for suffix in ("postgres_data", "redis_data")
+        )
+
+    candidate = base
+    counter = 0
+    while is_taken(candidate):
+        counter += 1
+        candidate = "{0}-{1}".format(base, counter)
+    return candidate
+
+
+def _port_is_free(port):
+    """True if ``port`` can be bound on this host right now."""
+    with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+        try:
+            sock.bind(("", port))
+            return True
+        except OSError:
+            return False
+
+
+def _reserved_sibling_ports(output_dir):
+    """Host ports already assigned to sibling projects' ``.env`` files.
+
+    ``init`` picks ports that are free *now*, but a project created a moment ago
+    may not have its containers up yet, so its port would still look free. Reading
+    the ports it reserved in ``.env`` lets us hand out distinct ones to each
+    project generated in the same directory.
+    """
+    reserved = set()
+    try:
+        entries = os.listdir(output_dir)
+    except OSError:
+        return reserved
+    for entry in entries:
+        env_path = os.path.join(output_dir, entry, ".env")
+        if not os.path.isfile(env_path):
+            continue
+        try:
+            with open(env_path) as env_file:
+                for line in env_file:
+                    match = re.match(r"(?:POSTGRES_PORT|REDIS_PORT)=(\d+)\s*$", line)
+                    if match:
+                        reserved.add(int(match.group(1)))
+        except OSError:
+            continue
+    return reserved
+
+
+def _pick_host_port(preferred, reserved):
+    """First port from ``preferred`` up that is free and not already reserved.
+
+    Mutates ``reserved`` so the same call site can pick several distinct ports
+    (e.g. Postgres then Redis) without handing out a duplicate.
+    """
+    port = preferred
+    while port in reserved or not _port_is_free(port):
+        port += 1
+    reserved.add(port)
+    return port
+
+
+@main.command()
+def init():
+    """Scaffold a new DjangoRocket project in the current directory."""
+    project_name = click.prompt("Project name", default="My Project")
+    base_template = importlib.resources.files("djangorocket.templates.projects").joinpath("base")
+
+    output_dir = os.getcwd()
+
+    # Pick a project directory name that is free both on disk and as a docker
+    # volume prefix, so several generated projects can coexist on one machine.
+    project_dirname = _available_project_dirname(
+        _slugify_dirname(project_name),
+        output_dir,
+        _existing_docker_volume_names(),
+    )
+
+    # Pick free host ports so several projects' Postgres/Redis can run at once.
+    reserved_ports = _reserved_sibling_ports(output_dir)
+    postgres_host_port = _pick_host_port(5432, reserved_ports)
+    redis_host_port = _pick_host_port(6379, reserved_ports)
+
+    try:
+        with _spinner("Creating your project..."):
+            project_dir = cookiecutter(
+                str(base_template),
+                no_input=True,
+                extra_context={
+                    "project_name": project_name,
+                    "project_dirname": project_dirname,
+                    "postgres_host_port": str(postgres_host_port),
+                    "redis_host_port": str(redis_host_port),
+                },
+            )
+    except OutputDirExistsException as e:
+        detail = str(e).removeprefix("Error: ")
+        raise click.ClickException(
+            f"{detail}. Remove it or pick a different project name and try again."
+        )
+
+    click.echo(click.style(f"✓ Created {os.path.relpath(project_dir)}", fg="green"))
+    # Point at the absolute path: `init` may have been run from anywhere (e.g.
+    # `make playground` runs it in $PLAYGROUND_BASE_DIR), and the next step is
+    # opening the project in an editor, not cd-ing in this shell.
+    click.echo(f"  Open the project in your editor: {os.path.abspath(project_dir)}")
+
+
+@main.command()
+@click.argument("components", nargs=-1)
+@click.option("--templates-dir", default=None, help="Directory where the new template source file should be added to.")
+def add(components, templates_dir):
+    """Add a UI cookiecutter template to an existing DjangoRocket project."""
+    try:
+        if templates_dir is None:
+            django_settings = DjangoSettingsManager()
+            templates_dir = django_settings.get_templates_dir()
+
+        add_components(components, templates_dir)
+    except Exception as e:
+        click.echo(f"Error: {e}")

djrocket-1.0.0a2/djangorocket/components.py

@@ -0,0 +1,39 @@
+import importlib.resources
+
+from cookiecutter.main import cookiecutter
+
+UI_TEMPLATES_PACKAGE = "djangorocket.templates.ui"
+
+
+def available_components():
+    """Names of the UI templates packaged with this install.
+
+    Templates ship as ``<name>.zip`` built from ``templates/ui/<name>/`` by
+    ``setup.py`` (see ``tools/zip_templates.py``), so the packaged zips are the
+    source of truth for what ``add`` can install.
+    """
+    return sorted(
+        resource.name.removesuffix(".zip")
+        for resource in importlib.resources.files(UI_TEMPLATES_PACKAGE).iterdir()
+        if resource.name.endswith(".zip")
+    )
+
+
+def add_components(components, templates_dir=None):
+    for component_name in components:
+        add_component(component_name, templates_dir)
+
+
+def add_component(component_name, templates_dir=None):
+    """Render the ``component_name`` UI template into ``templates_dir``."""
+    resource = importlib.resources.files(UI_TEMPLATES_PACKAGE).joinpath(f"{component_name}.zip")
+    if not resource.is_file():
+        raise ValueError(
+            f"unknown component '{component_name}'. "
+            f"Available components: {', '.join(available_components()) or 'none'}."
+        )
+
+    # cookiecutter needs a real filesystem path, which a zipped install does not
+    # expose directly; ``as_file`` materialises one for the duration of the block.
+    with importlib.resources.as_file(resource) as template_path:
+        cookiecutter(str(template_path), output_dir=templates_dir)