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

Added functionality to import perfect Excel #3059

Merged
merged 10 commits into from Aug 3, 2023

Conversation

IamEzio
Copy link
Contributor

@IamEzio IamEzio commented Jul 18, 2023

Fixes part of #3027

This PR adds methods to import Excel files into Mathesar.

Screenshots

perfect-excel.mp4

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@kgodey
Copy link
Contributor

kgodey commented Jul 18, 2023

Out of curiosity, what is "perfect Excel"?

@IamEzio
Copy link
Contributor Author

IamEzio commented Jul 18, 2023

Hi @kgodey, a perfect Excel has a single sheet with a single table in it. This PR gets the basic functionality of importing Excel files into the codebase. Later PRs will introduce a sheet_number paramter that will allow user to specify the sheet we want to pick up the table from.

@kgodey
Copy link
Contributor

kgodey commented Jul 18, 2023

Thanks @IamEzio!

@IamEzio IamEzio marked this pull request as ready for review July 19, 2023 02:57
@IamEzio
Copy link
Contributor Author

IamEzio commented Jul 19, 2023

@dmos62 @Anish9901 PTAL. Thanks!

@rajatvijay rajatvijay requested a review from dmos62 July 19, 2023 15:24
@rajatvijay rajatvijay added the pr-status: review A PR awaiting review label Jul 19, 2023
@rajatvijay rajatvijay added this to the GSoC 2023 milestone Jul 19, 2023
db/records/operations/insert.py Outdated Show resolved Hide resolved
mathesar/imports/excel.py Outdated Show resolved Hide resolved
mathesar/imports/excel.py Outdated Show resolved Hide resolved
mathesar/imports/excel.py Outdated Show resolved Hide resolved
mathesar/imports/excel.py Outdated Show resolved Hide resolved
mathesar/utils/datafiles.py Outdated Show resolved Hide resolved
mathesar/utils/datafiles.py Show resolved Hide resolved
@IamEzio IamEzio requested a review from dmos62 July 29, 2023 05:49
@IamEzio
Copy link
Contributor Author

IamEzio commented Jul 29, 2023

@dmos62 I have updated the PR. PTAL. Thanks!

We pass 'records' as the orientation parameter because we want each record to contain
data of a single row and not of a single column (which is the default behaviour).
"""
return json.loads(df.to_json(orient='records'))
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice and clear 👍

try:
table = insert_data_from_excel_data_file(name, schema, column_names, engine, comment, excel_filepath)
table = insert_data_from_excel_data_file(name, schema, column_names, engine, comment, dataframe)
Copy link
Contributor

Choose a reason for hiding this comment

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

this should be renamed to

Suggested change
table = insert_data_from_excel_data_file(name, schema, column_names, engine, comment, dataframe)
table = insert_data_from_dataframe(name, schema, column_names, engine, comment, dataframe)

because, you're inserting from a dataframe here, it coming from excel is irrelevant (correct me if I'm wrong), or even

Suggested change
table = insert_data_from_excel_data_file(name, schema, column_names, engine, comment, dataframe)
table = insert_records_from_dataframe(name, schema, column_names, engine, comment, dataframe)

because, you refered to data as records in another place: both data and records work, imo, but you want to be consistent with how you're referring to rows/data/records.

@dmos62 dmos62 added this pull request to the merge queue Aug 3, 2023
Merged via the queue into mathesar-foundation:develop with commit 6bdb38a Aug 3, 2023
9 checks passed
@IamEzio IamEzio deleted the perfect-excel branch August 4, 2023 05:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants