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

Datasets quick fixes + SQLAlchemy addition + CFF updates #339

Merged
merged 4 commits into from
Sep 27, 2024

Conversation

egpbos
Copy link
Member

@egpbos egpbos commented Sep 25, 2024

Changes in this PR

Fixes:

  • Layout fixes in the datasets chapter that was added today (I did do the local preview this time that the checklist told me to do 😅).
  • Added @suvayu, @f-hafner and @recap as page owners, if you all agree :)
  • Added the authors of the datasets chapter to the CFF file (...again, as the checklist suggested 🫣)

Adds:

  • In (Python) database tools / chapter? #316 we discussed (among many things) replacing all the Python chapter database interfaces with SQLalchemy. I now added mention of this to the databases chapter. Closes (Python) database tools / chapter? #316.
  • The CFF file was not updated much for the past 5 years. I went through past closed PRs to add the author names. If people want to add their ORCID, feel free to suggest in a review comment, or simply push it to this branch.

Checklist

  • I previewed my changes locally using e.g. python3 -m http.server 4000 and confirmed they work correctly.
  • My name AND MANY OTHERS ;) was added to the CITATION.cff file.


- [SQLAlchemy](https://www.sqlalchemy.org/)
- In Python, interfacing to SQL databases like SQLite, MySQL or PostgreSQL is often done using [SQLAlchemy](https://www.sqlalchemy.org/), which is an Object Relational Mapper (ORM) that allows you to map tables to Python classes. Note that you still need to use a lot of manual SQL outside of Python to manage the database. However, SQLAlchemy allows you to use the data in a Pythonic way once you have the database layout figured out.

Copy link
Member

Choose a reason for hiding this comment

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

I was thinking maybe piccolo deserves a mention here, considering it's much simpler, and probably better fit for smaller projects.

Copy link
Member Author

Choose a reason for hiding this comment

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

Please, by all means, add it. I am not at all an expert on databases, this is just a thing I happen to have used once.

Copy link
Member Author

Choose a reason for hiding this comment

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

Or perhaps we can do that in another PR and I'll just make an issue about it first to remember (maybe others have additional ideas that they can discuss there).

Copy link
Member Author

Choose a reason for hiding this comment

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

Done #346. Thanks for the review!

@egpbos egpbos mentioned this pull request Sep 27, 2024
@egpbos egpbos merged commit 823ec15 into main Sep 27, 2024
1 check passed
@egpbos egpbos deleted the datasets_quick_fixes branch September 27, 2024 19:41
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.

(Python) database tools / chapter?
2 participants