230 customizing results output

[AnirudhVIyer]

Enabled urls in ResultSet output and pandas DataFrame to be clickable

Issue ticket number and link

Closes #230

Checklist before requesting a review

• I have performed a self-review of my code
• I have added thorough tests (when necessary).
• I have added the right documentation in the docstring and changelog (when needed)

---

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

[edublancas]

is this ready for review? looks like you ran some markdown formatted cause the CHANGELOG was edited

[AnirudhVIyer]

Yeah, it is ready for review.

[edublancas]

please check your formatting settings, I see a lot of changes in files that should not be edited (example, the CHANGELOG and some test files)

[AnirudhVIyer]

Will do that.

[AnirudhVIyer]

I have added a new table with urls in the conftest file to run a few tests. Is it alright?

[idomic]

I have added a new table with urls in the conftest file to run a few tests. Is it alright?

If you can't use/utilize the existing fixtures then it's fine.

[AnirudhVIyer]

Hi @edublancas can you approve the workflow checks. Thank You.

[idomic]

@AnirudhVIyer please make sure you've added the issue number it closes in the PR description.

[edublancas]

overall it looks good, just added one minor comment.

I had an issue reproducing it for pandas data frames, am I doing something wrong?

[AnirudhVIyer]

overall it looks good, just added one minor comment.

I had an issue reproducing it for pandas data frames, am I doing something wrong?

Hi Eduardo, to make the URLs clickable in a dataframe, we need to add a style function that returns a Styler object, not the original dataframe. If we return the Styler object, users won't be able to conduct further analysis on it. Therefore, I added a styling function to the returned dataframe as an attribute. Users can use this attribute to display clickable links when they want to but still retain the original dataframe for further use.

you can display the dataframe with styling like this:

df.styled_func()

[edublancas]

ok, since getting this to work with pandas involves users knowing a bit of the implementation details, I think it's better to only keep the URL parsing the ResultSet - it's ok if the links go away when turning it into a pandas data frame

[AnirudhVIyer]

ok, since getting this to work with pandas involves users knowing a bit of the implementation details, I think it's better to only keep the URL parsing the ResultSet - it's ok if the links go away when turning it into a pandas data frame

Sure, I will make the required changes.

[AnirudhVIyer]

I have removed the pandas url attribute.

[edublancas]

great work!

[AnirudhVIyer]

thank you!

[idomic]

Thanks for committing @AnirudhVIyer !
If you're up for it, this is another good first issue you can tackle!