Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

using py scripts tutorial #558

Merged
merged 1 commit into from
Jun 6, 2023
Merged

using py scripts tutorial #558

merged 1 commit into from
Jun 6, 2023

Conversation

neelasha23
Copy link

@neelasha23 neelasha23 commented May 31, 2023

Describe your changes

User guide on embedding SQL queries in .py files

Issue number

Closes #449

Checklist before requesting a review


📚 Documentation preview 📚: https://jupysql--558.org.readthedocs.build/en/558/

@neelasha23
Copy link
Author

A doubt: The original issue mentions that this guide is meant for users who do not use notebooks and work with .py scripts. However in the guide we are taking the help of notebooks for creating the percent py file. and this file needs to be run as notebook. running them as py script is throwing error.
Do we need to need to eliminate the notebook step and try to create the percent py script without it?
@edublancas

@edublancas
Copy link

@neelasha23: yeah, we shouldn't be talking about notebooks here or using them to generate the py file. I think we can just have a snippet in percent-format that people can copy paste (e.g., a shorter version of our duckdb tutorial) into VSCode.

and then show some screenshots and instructions on how they can run it - I don't think there's much to say since VSCode will automatically detect the py files in percent format, but it's still good to guide them with some screenshots

does this answer the question?

@neelasha23
Copy link
Author

does this answer the question?

yes it does!

@neelasha23 neelasha23 force-pushed the sqlpy branch 2 times, most recently from 216e082 to 5e75bc1 Compare June 2, 2023 18:19
@neelasha23 neelasha23 marked this pull request as ready for review June 2, 2023 18:28
Copy link

@lfunderburk lfunderburk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @neelasha23

Added minor comments. Great work!

doc/user-guide/embed-sql-py.md Outdated Show resolved Hide resolved
doc/user-guide/embed-sql-py.md Outdated Show resolved Hide resolved
Copy link

@edublancas edublancas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please address @lfunderburk observations

doc/_toc.yml Outdated Show resolved Hide resolved
doc/user-guide/embed-sql-py.md Outdated Show resolved Hide resolved
@edublancas edublancas changed the title Embedded SQL queries using py scripts tutorial Jun 5, 2023
@neelasha23 neelasha23 changed the title using py scripts tutorial embed in py scripts tutorial Jun 6, 2023
@neelasha23 neelasha23 changed the title embed in py scripts tutorial using py scripts tutorial Jun 6, 2023
lint

screenshots

added images

Review comments

spyder screenshot

pycharm added
@edublancas edublancas merged commit 95a11fa into ploomber:master Jun 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add capability to embed SQL queries inside .py scripts
3 participants