Support reflex app creation from templates from github #2490

martinxu9 · 2024-01-31T00:02:12Z

Summary

Support reflex app creation from templates from github
- When reflex init: fetch from reflex backend server: the list of Reflex apps that can be used as a starting template (name and their URL). When no internet or backend is unreachable, only blank is shown to user.
- Prompt user for template selection: default is blank.
- Upon valid selection, download the source files as a zip. The Zip structure must contain a top level directory, which contains the rxconfig. This is the standard structure downloaded from github repos.
- Extract all files from zip, copy files into current directory
- Prompt for name change, by default the name is the valid reflex app name constructed by current directory name (e.g. no dashes allowed).
- Rename folders/files, fix imports
Not supported:
- Download a sub-directory in a github repo as standalone zip.

Usage:
reflex init --template https://github.com/reflex-dev/reflex-chat

Tests

Tested with CP running https://github.com/reflex-dev/reflex-hosting/pull/232 locally with following (below are not the final/real templates):
- blank_template: https://github.com/reflex-dev/blank-template/archive/main.zip
- chat_app: https://api.github.com/repos/reflex-dev/reflex-chat/zipball/ee5b472

picklelo

Works well for me (though I wasn't able to connect to get the list of templates). Maybe for now we can leave out the interactive init and support initialization with the --template flag only. I think I they do --template without any args, that's where we could show all the templates we offer through the CLI.

picklelo · 2024-02-02T21:54:12Z

reflex/reflex.py

-            template = prerequisites.prompt_for_template()
-        prerequisites.create_config(app_name)
-        prerequisites.initialize_app_directory(app_name, template)
+        # Fetch App templates from the backend server


Let's move all of this to a function in prerequisites.py to keep this function clean

picklelo · 2024-02-02T21:55:21Z

reflex/utils/prerequisites.py

+def initialize_app_directory(
+    app_name: str,
+    template_name: str = constants.Templates.Kind.BLANK.value,
+    template_code_dir_name: Optional[str] = None,


I think we can do | None instead of Optional outside of Pydantic use cases

picklelo · 2024-02-02T21:59:39Z

reflex/utils/prerequisites.py

+    except OSError as ose:
+        console.error(f"Failed to create temp directory for download: {ose}")
+        raise typer.Exit(1) from ose
+    # Use httpx GET with redirects to download the zip file


nit: can we put blank lines before each comment to make the code more readable

picklelo · 2024-02-02T22:00:01Z

reflex/utils/prerequisites.py

+        A valid template name.
+    """
+    if template is not None:
+        # If user selects a template, it needs to exist


nit: end comments with periods for consistency

picklelo · 2024-02-02T22:01:01Z

reflex/utils/prerequisites.py

+    # the source code repo name on github
+    template_name = new_config.app_name
+
+    # Prompt for Reflex App name change


Should we move this section to its own function? I think this may in the future be useful as its own subcommand reflex init --rename <new_name>

remove this section for now. Let me do that when we add --rename. The rename is slightly differently I suppose. Here, we basically generate a new rxconfig file instead regex replace any strings. I suspect we might have to do string substitution when it a generic app. There might be other attributes added in the template app.

martinxu9 · 2024-02-09T18:37:21Z

Works well for me (though I wasn't able to connect to get the list of templates). Maybe for now we can leave out the interactive init and support initialization with the --template flag only. I think I they do --template without any args, that's where we could show all the templates we offer through the CLI.

do you know how to achieve that in typer option? From what I experimented, if it's not a boolean flag, it'll expect something set for that flag or no flag at all for None.

martinxu9 · 2024-04-04T21:07:27Z

reflex/utils/prerequisites.py

-    templates = fetch_app_templates() or {}
-    if template is None:
-        template = prompt_for_template(templates)
+    templates: dict[str, Template] = fetch_app_templates() or {}


nit: fetch_app_templates always return a dict, no need for or {}

good catch, fixed

When changing page in a stateless app, there is no state to set `is_hydrated: False`

martinxu9 · 2024-04-04T21:39:54Z

reflex/utils/prerequisites.py

+            template_url = templates[template].code_url
+        else:
+            # Check if the template is a github repo.
+            if "github.com" not in template:


should it be a more strict check something like it must start with https://github.com/ or something?

martinxu9 · 2024-04-04T21:42:28Z

reflex/utils/prerequisites.py

+                console.error(f"Template `{template}` not found.")
+                raise typer.Exit(1)
+            repo = template.split("github.com/")[1].strip("/")
+            template_url = f"https://github.com/{repo}/archive/main.zip"


looks like we expect the template_url to be of https://github.com/owner/repo/ format, do we want to just right strip / then append main.zip which also means we can't specify a branch for now. Likely ok

martinxu9 force-pushed the martinxu9/from-template branch from 798e47d to 2c62bfe Compare January 31, 2024 00:16

martinxu9 requested a review from picklelo January 31, 2024 00:32

martinxu9 marked this pull request as ready for review February 1, 2024 02:58

picklelo reviewed Feb 2, 2024

View reviewed changes

picklelo force-pushed the martinxu9/from-template branch from cfa5db2 to 07ea15b Compare April 2, 2024 20:13

martinxu9 commented Apr 4, 2024

View reviewed changes

martinxu9 and others added 16 commits April 4, 2024 14:37

first working version

e930f2c

fix CI

055cf10

remove sidebar from docker CI

5c289a6

remove extra print

9fdea0d

cleanup; refactor to helpers

2810a03

fix app harness test

ce15644

review comments

4cd500c

Rebase

324e6bc

Fix lint

82af67e

Clean up init workflow

e87bf50

blank template

c1dae9f

Remove sidebar template

77665e6

state.js: do not call an undefined function

ac4062f

When changing page in a stateless app, there is no state to set `is_hydrated: False`

Make --template flag work

372b511

Support github urls

b2e2acc

Drop coverage

d190d64

picklelo force-pushed the martinxu9/from-template branch from a034a8a to d190d64 Compare April 4, 2024 21:37

martinxu9 commented Apr 4, 2024

View reviewed changes

Check github url

3709b08

picklelo approved these changes Apr 4, 2024

View reviewed changes

picklelo merged commit 7d36610 into main Apr 4, 2024
46 checks passed

masenf deleted the martinxu9/from-template branch April 24, 2024 18:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support reflex app creation from templates from github #2490

Support reflex app creation from templates from github #2490

martinxu9 commented Jan 31, 2024 •

edited by picklelo

Loading

picklelo left a comment

picklelo Feb 2, 2024

picklelo Feb 2, 2024

picklelo Feb 2, 2024

picklelo Feb 2, 2024

picklelo Feb 2, 2024

martinxu9 Feb 9, 2024

martinxu9 commented Feb 9, 2024

martinxu9 Apr 4, 2024

picklelo Apr 4, 2024

martinxu9 Apr 4, 2024

martinxu9 Apr 4, 2024

Support reflex app creation from templates from github #2490

Support reflex app creation from templates from github #2490

Conversation

martinxu9 commented Jan 31, 2024 • edited by picklelo Loading

Summary

Tests

picklelo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

martinxu9 commented Feb 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

martinxu9 commented Jan 31, 2024 •

edited by picklelo

Loading