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

Add link to ORM package #1470

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add link to ORM package #1470

wants to merge 1 commit into from

Conversation

s2t2
Copy link

@s2t2 s2t2 commented May 21, 2024

Hi, I created a package called gspread-models to provide an ORM style interface on top of gspread.

I would like to add a link from the gspread docs to the gspread-models homepage.

I chose a spot in the docs I thought might be appropriate, but I'm open to edits and suggestions.

I am new to RST but I tried to follow the other examples.

@s2t2 s2t2 changed the title Add link to ORM package Add link to ORM package (Update Docs Only) May 21, 2024
@s2t2 s2t2 changed the title Add link to ORM package (Update Docs Only) Add link to ORM package May 21, 2024
@alifeee
Copy link
Collaborator

alifeee commented May 22, 2024

The package you have made looks interesting and useful! :)

I do not think it needs to be called "gspread models". It is not related to gspread. It only uses the API. It could be "google sheets ORM" or anything you like. I only say this as sometimes people come into this repository for addon questions (for example with gspread-formatting), but we do not create these packages.

I think(?) we do not currently link to other projects like https://github.com/robin900/gspread-formatting or this project, but maybe it would be nice to have this somewhere like "extra tools"/"community addons" in the documentation.

Will also get @lavigne958's thoughts and then decide to link to this somewhere.

@s2t2
Copy link
Author

s2t2 commented May 22, 2024

OK cool, thanks!

I had seen links to gspread-pandas and gspread-dataframe near the bottom of the user guide:
https://docs.gspread.org/en/latest/user-guide.html#using-gspread-with-pandas

The gspread-models package does use and require gspread. But I would be happy to rename the package if desired. Just let me know.

Alternatively, if we want to incorporate the model-based functionality into gspread, and sunset gspread-models, I would be happy to introduce a PR.

Copy link
Collaborator

@lavigne958 lavigne958 left a comment

Choose a reason for hiding this comment

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

Hi thank you for this collaboration.

I don't mind so much the name, there are already gspread-formating and gspread-dataframe after all.

I am not too sure this should be placed in Advanced section, rather in the Example of gspread section.

you could add-yourself a new section at the after numpy section.

You don't need to have a large detailed text, it's all up to you I would say.

Comment on lines +76 to +80
Object Relational Mappers (ORMs)
---------------------

gspread-models
~~~~~~~~~~~~~~~~~~~
Copy link
Collaborator

Choose a reason for hiding this comment

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

this won't pass the test, the doc won't build.
please extend the length of the underlying markers (-) and (~) to be aligned with the text above them.

@lavigne958
Copy link
Collaborator

I like the idea of having a dedicated section about "Extended tools" or "Community extensions".

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.

None yet

3 participants