feat: add ability in robyn cli to scaffold example programs with various DBs #584

bwdq · 2023-08-15T20:13:53Z

Fixes #511 and adds some example code for scaffolding Sqlite, Postgres, Mongo, Prisma, and SQLAlchemy.

netlify · 2023-08-15T20:19:36Z

👷 Deploy request for robyn pending review.

Name	Link
🔨 Latest commit	`386a040`

codspeed-hq · 2023-08-15T20:48:12Z

CodSpeed Performance Report

Merging #584 will not alter performance

_{Comparing bwdq:scaffold-v3 (8b0cb47) with main (f4a9de0)}

Summary

✅ 106 untouched benchmarks

sansyrox · 2023-08-16T08:16:28Z

Hey @bwdq 👋

Great work 😄

I will have a thorough look over the weekend but this great work so far!

sansyrox

Hey @bwdq 👋

Great work 😄 I have a few suggestions. Do let me know if you have any questions from me 😄

Also, can you please bring the Dockerfile in the scaffold folder instead of generating it on the fly?

sansyrox · 2023-08-19T20:58:46Z

robyn/scaffold/mongo.py

All these databases would also require certain dependencies. Can we update the docker files accordingly?

I have updated the Docker files for the databases. When I ran docker it errored 'uvloop not found' so uvloop should be a mandatory dependency instead of optional.

sansyrox · 2023-08-19T21:04:22Z

robyn/__main__.py

    project_dir = result[0]
    docker = result[1]
+    project_type = result[2]


Suggested change

project_dir = result[0]

docker = result[1]

project_type = result[2]

project_dir, docker, project_type = result

I tried this and it did not parse correctly so I left it as is

@bwdq , what do you mean by this? What error were you getting?

We can return a dictionary instead of a tuple if there is an issue

I would advise returning result as dict instead of tuple, will make it more clear what is what and avoid future issues in case a new question is added or the order changes.

robyn/__main__.py

robyn/scaffold/docker/Dockerfile-mongo

sansyrox · 2023-08-26T22:55:35Z

robyn/scaffold/prisma/app.py

+
+# install prisma cli
+# initialize prisma with "prisma generate"
+# then "prisma migrate dev" and name migration dev


@bwdq 👋

Can you please explain the line here?

These are instructions to the user because prisma won't "just work" and requires some setup. I'm not sure what the optimal solution here is. I don't want to execute bash commands silently.

hey @bwdq 👋

We can add a small readme inside every folder. Doesn't need to be too fancy. Can just contain these commands.

I have moved the python comments to README's.

sansyrox · 2023-09-11T04:49:09Z

robyn/scaffold/sqlite/app.py

+    res = cur.execute("SELECT name FROM sqlite_master")
+    th = res.fetchone()
+    print(th)
+    return "Hello World!"


I believe that we should be including res in the final response.

done
table_name = th[0] return f"Hello World! {table_name}"

sansyrox · 2023-09-11T19:14:37Z

robyn/__main__.py

+        if project_type == "sqlite":
+            f.write(open("robyn/scaffold/sqlite/app.py", "r").read())
+        elif project_type == "postgres":
+            f.write(open("robyn/scaffold/postgres/app.py", "r").read())
+            # copy README.md
+            readme_path = os.path.join(project_dir, "README.md")
+            with open(readme_path, "w") as f_r:
+                f_r.write(open("robyn/scaffold/postgres/README.md", "r").read())
+        elif project_type == "mongo":
+            f.write(open("robyn/scaffold/mongo/app.py", "r").read())
+        elif project_type == "sqlalchemy":
+            f.write(open("robyn/scaffold/sqlalchemy/app.py", "r").read())
+        elif project_type == "prisma":
+            f.write(open("robyn/scaffold/prisma/app.py", "r").read())
+            # copy schema.prisma
+            schema_path = os.path.join(project_dir, "schema.prisma")
+            with open(schema_path, "w") as f_s:
+                f_s.write(open("robyn/scaffold/prisma/schema.prisma", "r").read())
+            # copy README.md
+            readme_path = os.path.join(project_dir, "README.md")
+            with open(readme_path, "w") as f_r:
+                f_r.write(open("robyn/scaffold/prisma/README.md", "r").read())
+        else:
+            f.write(open("robyn/scaffold/no-db/app.py", "r").read())


I wonder if there is a cleaner way to implement this?

can you store the file_name and file_paths in a dictionary and then try accessing it?

@IdoKendo do you have any thoughts on this?

I would simplify this whole block to something like these 3 lines:

base_path = f"robyn/scaffold/{project_type}" shutil.copyfile(f"{base_path}/README.md", readme_path) shutil.copyfile(f"{base_path}/app.py", app_file_path)

Just make sure the project_type default is no-db 😃
Can add some guard clauses to be extra safe, but I think InquirerPy does that for you out-of-the-box.

Upon further review of the code, can even do it as simple as:

from distutils.dir_util import copy_tree copy_tree(project_dir, f"robyn/scaffold/{project_type}")

This is much simpler but at the time I didn't want to add a new dependency. I've switched to this now.

sansyrox · 2023-09-11T19:15:04Z

robyn/__main__.py

+            if project_type == "sqlite":
+                f.write(open("robyn/scaffold/sqlite/Dockerfile", "r").read())
+            elif project_type == "postgres":
+                f.write(open("robyn/scaffold/postgres/Dockerfile", "r").read())
+            elif project_type == "mongo":
+                f.write(open("robyn/scaffold/mongo/Dockerfile", "r").read())
+            elif project_type == "sqlalchemy":
+                f.write(open("robyn/scaffold/sqlalchemy/Dockerfile", "r").read())
+            elif project_type == "prisma":
+                f.write(open("robyn/scaffold/prisma/Dockerfile", "r").read())
+            else:


same for this

IdoKendo

Hey @bwdq 👋 Nice job!
I've added some comments to simplify and improve upon the changes. LMK if there's anything I can help with!

IdoKendo · 2023-09-12T05:54:45Z

robyn/__main__.py

    project_dir = result[0]
    docker = result[1]
+    project_type = result[2]


I would advise returning result as dict instead of tuple, will make it more clear what is what and avoid future issues in case a new question is added or the order changes.

robyn/__main__.py

robyn/scaffold/mongo/Dockerfile

IdoKendo · 2023-09-12T06:02:10Z

robyn/__main__.py

+        if project_type == "sqlite":
+            f.write(open("robyn/scaffold/sqlite/app.py", "r").read())
+        elif project_type == "postgres":
+            f.write(open("robyn/scaffold/postgres/app.py", "r").read())
+            # copy README.md
+            readme_path = os.path.join(project_dir, "README.md")
+            with open(readme_path, "w") as f_r:
+                f_r.write(open("robyn/scaffold/postgres/README.md", "r").read())
+        elif project_type == "mongo":
+            f.write(open("robyn/scaffold/mongo/app.py", "r").read())
+        elif project_type == "sqlalchemy":
+            f.write(open("robyn/scaffold/sqlalchemy/app.py", "r").read())
+        elif project_type == "prisma":
+            f.write(open("robyn/scaffold/prisma/app.py", "r").read())
+            # copy schema.prisma
+            schema_path = os.path.join(project_dir, "schema.prisma")
+            with open(schema_path, "w") as f_s:
+                f_s.write(open("robyn/scaffold/prisma/schema.prisma", "r").read())
+            # copy README.md
+            readme_path = os.path.join(project_dir, "README.md")
+            with open(readme_path, "w") as f_r:
+                f_r.write(open("robyn/scaffold/prisma/README.md", "r").read())
+        else:
+            f.write(open("robyn/scaffold/no-db/app.py", "r").read())


Upon further review of the code, can even do it as simple as:

from distutils.dir_util import copy_tree copy_tree(project_dir, f"robyn/scaffold/{project_type}")

sansyrox · 2023-09-13T11:28:43Z

Thanks for the review @IdoKendo 😄

I wasn't aware about this feature

from distutils.dir_util import copy_tree

sansyrox · 2023-09-18T19:19:32Z

Any updates on this @bwdq ?

vercel · 2023-09-25T02:20:09Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
robyn	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 30, 2023 9:55pm

bwdq · 2023-09-25T02:59:34Z

I have updated and simplified the logic in main. I'm still having issues with the robyn resetting the connection when running on docker and some testing would be helpful.

sansyrox · 2023-09-30T22:24:52Z

Hey @bwdq 👋

I'm still having issues with the robyn resetting the connection when running on docker and some testing would be helpful.

Can you please explain what you mean here? I don't understand what you mean by "resetting" the connection.

bwdq · 2023-10-01T01:23:07Z

The issue isn't really related to this PR because it's reproducible on the main branch so I've opened a separate issue for it.
#621

sansyrox · 2023-10-03T19:21:38Z

Hey @bwdq 👋

Is the PR up for review?

bwdq · 2023-10-03T21:34:14Z

Hey @bwdq 👋

Is the PR up for review?

Yes it is. The docker issue is now fixed.

sansyrox · 2023-10-08T21:57:35Z

Hey @bwdq 👋

I have two suggestions for this PR

there are some conflicts. Can we please resolve them?
can we add some documentation regarding the new change in the new_docs folder?

robyn/scaffold/no-db/Dockerfile

robyn/scaffold/postgres/app.py

sansyrox

Hey @bwdq 👋

I was going trying your branch and when I run the command python -m robyn --create

I get the following error

Please select project type (Mongo/Postgres/Sqlalchemy/Prisma):  Sqlite
Creating a new Robyn project '.'...
Traceback (most recent call last):
  File "/Users/sanskar/.pyenv/versions/3.10.7/lib/python3.10/runpy.py", line 196, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "/Users/sanskar/.pyenv/versions/3.10.7/lib/python3.10/runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "/Users/sanskar/repos/robyn/robyn/__main__.py", line 68, in <module>
    create_robyn_app()
  File "/Users/sanskar/repos/robyn/robyn/__main__.py", line 51, in create_robyn_app
    copy_tree(f"robyn/scaffold/{project_type}/", project_dir)
  File "/Users/sanskar/repos/robyn/venv/lib/python3.10/site-packages/setuptools/_distutils/dir_util.py", line 135, in copy_tree
    raise DistutilsFileError("cannot copy tree '%s': not a directory" % src)
distutils.errors.DistutilsFileError: cannot copy tree 'robyn/scaffold/sqlite/': not a directory

And this is happening for every selection. Can you please have a look?

Mr-Sunglasses · 2023-10-30T20:41:25Z

@Mr-Sunglasses , can you please explain a bit more? What would be different?

@sansyrox I'm taking about sqlalchemy + alembic migration template but we can do after we migrate create_robyn_app to another repo ( #659 )

robyn/__main__.py

sansyrox · 2023-10-30T21:45:20Z

@Mr-Sunglasses , can you please explain a bit more? What would be different?

@sansyrox I'm taking about sqlalchemy + alembic migration template but we can do after we migrate create_robyn_app to another repo ( #659 )

@Mr-Sunglasses , can you please make an issue for the same?

…ion in main

…caffold

for more information, see https://pre-commit.ci

Mr-Sunglasses · 2023-10-30T21:47:04Z

@Mr-Sunglasses , can you please explain a bit more? What would be different?

@sansyrox I'm taking about sqlalchemy + alembic migration template but we can do after we migrate create_robyn_app to another repo ( #659 )

@Mr-Sunglasses , can you please make an issue for the same?

Sure.

for more information, see https://pre-commit.ci

Mr-Sunglasses

LGTM Great work Team 🙌🏻

IdoKendo

LGTM 🔥

sansyrox · 2023-10-30T22:18:42Z

Thank you @IdoKendo and @Mr-Sunglasses 😄 ✨

sansyrox reviewed Aug 19, 2023

View reviewed changes

robyn/__main__.py Outdated Show resolved Hide resolved

sansyrox reviewed Aug 23, 2023

View reviewed changes

robyn/scaffold/docker/Dockerfile-mongo Outdated Show resolved Hide resolved

sansyrox reviewed Aug 26, 2023

View reviewed changes

sansyrox reviewed Sep 11, 2023

View reviewed changes

IdoKendo suggested changes Sep 12, 2023

View reviewed changes

vercel bot had a problem deploying to Preview September 25, 2023 02:20 Failure

vercel bot had a problem deploying to Preview September 25, 2023 02:44 Failure

vercel bot had a problem deploying to Preview October 1, 2023 05:15 Failure

Mr-Sunglasses suggested changes Oct 10, 2023

View reviewed changes

robyn/scaffold/no-db/Dockerfile Show resolved Hide resolved

robyn/scaffold/postgres/app.py Show resolved Hide resolved

vercel bot deployed to Preview October 17, 2023 07:18 View deployment

vercel bot deployed to Preview October 17, 2023 07:24 View deployment

sansyrox reviewed Oct 22, 2023

View reviewed changes

sansyrox mentioned this pull request Oct 24, 2023

move create robyn app into a separate repo #659

Closed

Mr-Sunglasses suggested changes Oct 30, 2023

View reviewed changes

robyn/__main__.py Outdated Show resolved Hide resolved

sansyrox changed the title ~~[feat] issue #511 add ability in robyn cli to scaffold example programs with various DB's~~ #511 add ability in robyn cli to scaffold example programs with various DB's Oct 30, 2023

vercel bot deployed to Preview October 30, 2023 21:44 View deployment

sansyrox changed the title ~~#511 add ability in robyn cli to scaffold example programs with various DB's~~ feat: add ability in robyn cli to scaffold example programs with various DB's Oct 30, 2023

bwdq and others added 15 commits October 30, 2023 21:45

use pyinquire and added example files for various databases

334b8ad

move Docker file to scaffold/dockerfile and update dockerfile generat…

2bd0024

…ion in main

move scaffold app.py files and docker files to named directories in s…

e72041d

…caffold

move db/orm installation and use instructions to README files

201fca6

include res in the response

2723c49

use distutils to copy the file tree and use named dict with pyinquire

e5f00b2

update docker files to use latest python image

d0b3ff5

fix scaffolded projects to work in Docker

6d4c6d5

add requirements.txt for psycopg2

58ae29f

Fix scaffold templates

7dcf2a5

Fix create robyn app paths

8fb1d64

[pre-commit.ci] auto fixes from pre-commit.com hooks

79e7f20

for more information, see https://pre-commit.ci

Address suggestions

181085e

update

d3b9d0f

update final

88356b2

sansyrox force-pushed the scaffold-v3 branch from 0d82fc3 to 88356b2 Compare October 30, 2023 21:47

[pre-commit.ci] auto fixes from pre-commit.com hooks

8b0cb47

for more information, see https://pre-commit.ci

Mr-Sunglasses approved these changes Oct 30, 2023

View reviewed changes

vercel bot deployed to Preview October 30, 2023 21:55 View deployment

IdoKendo approved these changes Oct 30, 2023

View reviewed changes

sansyrox changed the title ~~feat: add ability in robyn cli to scaffold example programs with various DB's~~ feat: add ability in robyn cli to scaffold example programs with various DBs Oct 30, 2023

sansyrox merged commit 9f0c23d into sparckles:main Oct 30, 2023
46 of 60 checks passed

feat: add ability in robyn cli to scaffold example programs with various DBs #584

feat: add ability in robyn cli to scaffold example programs with various DBs #584

Conversation

bwdq commented Aug 15, 2023 • edited by sansyrox Loading

netlify bot commented Aug 15, 2023 • edited Loading

👷 Deploy request for robyn pending review.

codspeed-hq bot commented Aug 15, 2023 • edited Loading

Merging #584 will not alter performance

Summary

sansyrox commented Aug 16, 2023

sansyrox left a comment • edited Loading

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

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

bwdq Sep 25, 2023 • edited Loading

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

IdoKendo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sansyrox commented Sep 13, 2023

sansyrox commented Sep 18, 2023

vercel bot commented Sep 25, 2023 • edited Loading

bwdq commented Sep 25, 2023

sansyrox commented Sep 30, 2023

bwdq commented Oct 1, 2023

sansyrox commented Oct 3, 2023

bwdq commented Oct 3, 2023

sansyrox commented Oct 8, 2023

sansyrox left a comment

Choose a reason for hiding this comment

Mr-Sunglasses commented Oct 30, 2023

sansyrox commented Oct 30, 2023

Mr-Sunglasses commented Oct 30, 2023

Mr-Sunglasses left a comment

Choose a reason for hiding this comment

IdoKendo left a comment

Choose a reason for hiding this comment

sansyrox commented Oct 30, 2023

bwdq commented Aug 15, 2023 •

edited by sansyrox

Loading

netlify bot commented Aug 15, 2023 •

edited

Loading

codspeed-hq bot commented Aug 15, 2023 •

edited

Loading

sansyrox left a comment •

edited

Loading

bwdq Sep 25, 2023 •

edited

Loading

vercel bot commented Sep 25, 2023 •

edited

Loading