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

[ENH] Add tidyxl's xlsx_table to the io module. #990

Merged
merged 35 commits into from
Jan 18, 2022

Conversation

samukweku
Copy link
Collaborator

@samukweku samukweku commented Jan 16, 2022

PR Description

Please describe the changes proposed in the pull request:

  • Create DataFrame or dictionary of DataFrames from table(s) in xlsx sheet.

This PR resolves #992 .

PR Checklist

Please ensure that you have done the following:

  1. PR in from a fork off your branch. Do not PR from <your_username>:dev, but rather from <your_username>:<feature-branch_name>.
  1. If you're not on the contributors list, add yourself to AUTHORS.rst.
  1. Add a line to CHANGELOG.md under the latest version header (i.e. the one that is "on deck") describing the contribution.
    • Do use some discretion here; if there are multiple PRs that are related, keep them in a single line.

Automatic checks

There will be automatic checks run on the PR. These include:

  • Building a preview of the docs on Netlify
  • Automatically linting the code
  • Making sure the code is documented
  • Making sure that all tests are passed
  • Making sure that code coverage doesn't go down.

Relevant Reviewers

Please tag maintainers to review.

@samukweku samukweku self-assigned this Jan 16, 2022
@codecov
Copy link

codecov bot commented Jan 16, 2022

Codecov Report

Merging #990 (a6672db) into dev (ba46402) will increase coverage by 0.04%.
The diff coverage is 94.11%.

@@            Coverage Diff             @@
##              dev     #990      +/-   ##
==========================================
+ Coverage   96.28%   96.32%   +0.04%     
==========================================
  Files          77       77              
  Lines        2826     2859      +33     
==========================================
+ Hits         2721     2754      +33     
  Misses        105      105              

Copy link
Member

@ericmjl ericmjl left a comment

Choose a reason for hiding this comment

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

Great start, @samukweku! I put in some early review comments here. There are tests that are missing too, but I trust you're already working on them. Looking forward to reviewing!

janitor/io.py Outdated Show resolved Hide resolved
janitor/io.py Show resolved Hide resolved
@samukweku samukweku changed the title [WIP] Excel related Excel related Jan 17, 2022
@ericmjl
Copy link
Member

ericmjl commented Jan 17, 2022

I'm inclined to ignore the decrease in project test coverage; they're irrelevant to the PR. 100% of the patch diff being hit is good enough.

@ericmjl
Copy link
Member

ericmjl commented Jan 17, 2022

Btw, @samukweku, I think going forth you can use a branch off the pyjanitor repo, rather than a personal fork. Or otherwise, you can delete the old forks that you have and re-fork. (This is what I do with projects I'm not a maintainer on.) It helps eliminate the need to maintain a fork and keep the dev branch up-to-date.

Copy link
Member

@ericmjl ericmjl left a comment

Choose a reason for hiding this comment

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

I love the tests provided here, @samukweku, they're really comprehensive!

I have only a few nit-picky requests for changes. They are explicit requests for changes, rather than mere suggestions, because I think changing them will help with maintenance clarity. Hope you don't mind them!

janitor/io.py Outdated Show resolved Hide resolved
midpoint.csv Outdated Show resolved Hide resolved
tests/io/test_xlsx_table.py Show resolved Hide resolved
@ericmjl ericmjl changed the title Excel related [ENH] Add tidyxl's xlsx_table to the io module. Jan 17, 2022
CHANGELOG.md Outdated Show resolved Hide resolved
janitor/io.py Outdated Show resolved Hide resolved
janitor/io.py Outdated Show resolved Hide resolved
janitor/io.py Outdated Show resolved Hide resolved
janitor/io.py Outdated Show resolved Hide resolved
janitor/io.py Outdated Show resolved Hide resolved
janitor/io.py Show resolved Hide resolved
janitor/io.py Outdated Show resolved Hide resolved
janitor/io.py Outdated Show resolved Hide resolved
Copy link
Contributor

@thatlittleboy thatlittleboy left a comment

Choose a reason for hiding this comment

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

Sorry, immediately thought of another point I would like to make in the review right as I pressed "Submit" 😅

janitor/io.py Outdated Show resolved Hide resolved
Copy link
Member

@ericmjl ericmjl left a comment

Choose a reason for hiding this comment

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

I'm approving. I looked on CodeCov and saw that the missed patch is on the conditional import. I don't think it's easy to test that in the current testing environment, so we should let it go.

I'm going to approve! @thatlittleboy since you also did a big review on this one, feel free to approve and merge!

@thatlittleboy
Copy link
Contributor

@samukweku There's a merge conflict in CHANGELOG.md because of the previous PR going through. Could you address this, then I'll approve and merge? Thanks!

@thatlittleboy thatlittleboy merged commit 7a82016 into pyjanitor-devs:dev Jan 18, 2022
@samukweku samukweku deleted the excel_related branch January 18, 2022 06:39
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.

Read table(s) from Excel File
3 participants