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

enhancements #29

Merged
merged 10 commits into from
Jun 16, 2024
Merged

enhancements #29

merged 10 commits into from
Jun 16, 2024

Conversation

AHReccese
Copy link
Member

@AHReccese AHReccese commented Jun 13, 2024

Reference Issues/PRs

#27

  • add CLI tests to test.yml
  • some refactorings applied
  • Readme updated

What does this implement/fix? Explain your changes.

Any other comments?

@AHReccese AHReccese self-assigned this Jun 13, 2024
@codecov-commenter
Copy link

codecov-commenter commented Jun 13, 2024

Codecov Report

Attention: Patch coverage is 40.00000% with 3 lines in your changes missing coverage. Please review.

Please upload report for BASE (dev@4adb060). Learn more about missing BASE report.

Files Patch % Lines
dmeta/functions.py 40.00% 3 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff           @@
##             dev      #29   +/-   ##
======================================
  Coverage       ?   72.08%           
======================================
  Files          ?        4           
  Lines          ?      154           
  Branches       ?       42           
======================================
  Hits           ?      111           
  Misses         ?       36           
  Partials       ?        7           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@AHReccese AHReccese changed the title Enhance/cli enhancements Jun 13, 2024
@AHReccese
Copy link
Member Author

@sadrasabouri
Sadra could you please update the README links and badges?

@AHReccese
Copy link
Member Author

If you can do it, let me know so I can assign this PR to you too to do pairing stuff!
@sadrasabouri

@AHReccese AHReccese added documentation Improvements or additions to documentation enhancement New feature or request test labels Jun 13, 2024
@AHReccese AHReccese added this to the MetaDoc v0.1 milestone Jun 13, 2024
@sadrasabouri
Copy link
Member

@sadrasabouri Sadra could you please update the README links and badges?

Sure. I will do it.

CHANGELOG.md Outdated
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Changed
## [0.1] - 2024-05-29
### Added
- `CLI` Handler
Copy link
Member

Choose a reason for hiding this comment

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

I will change it to handler, is that OK?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes.

README.md Outdated
@@ -35,7 +35,7 @@

## Overview
<p align="justify">
DMeta is an open source Python package that provides ... TODO
DMeta is an open source Python package that removes metadata of microsoft office files.
Copy link
Member

Choose a reason for hiding this comment

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

I will change it to ... Microsoft Office ..., is that OK?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure, go ahead.

README.md Outdated

CONFIG_FILE_PATH = os.path.join(os.getcwd(), "CONFIG.json")
DOCX_FILE_PATH = os.path.join(os.getcwd(), "SAMPLE.docx")
update(DOCX_FILE_PATH, DOCX_FILE_PATH)
Copy link
Member

Choose a reason for hiding this comment

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

One of them should be config, I will fix it.

Copy link
Member Author

Choose a reason for hiding this comment

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

shit, yes you are right, the first one I guess.

Copy link
Member

@sadrasabouri sadrasabouri left a comment

Choose a reason for hiding this comment

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

Great work @AHReccese
I have a minor comment. Plus that I would suggest to use small case words for file names instead, ex sample.docx instead of SAMPLE.docx.
I will apply some changes and do the needed changes in the repository and then you can either apply or ignore these suggestions.

README.md Outdated
@@ -84,30 +84,68 @@ DMeta is an open source Python package that provides ... TODO
- Run `pip install .`

## Usage
### Programmatically
Copy link
Member

Choose a reason for hiding this comment

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

I suggest using ### In Python instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

Go ahead and apply yourself, then finally ping me, I will review them.

@AHReccese
Copy link
Member Author

Great Job Sadra, Go ahead and apply them all, then tag me for a final review.

Copy link
Member

@sadrasabouri sadrasabouri left a comment

Choose a reason for hiding this comment

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

LGTM, @AHReccese please review. If it is OK, we can merge it.

@AHReccese
Copy link
Member Author

Ok, great, lemmi review everything and then we will go for it.
@sadrasabouri
I will take care of the rest.

@AHReccese AHReccese merged commit 4502890 into dev Jun 16, 2024
42 checks passed
@AHReccese AHReccese deleted the enhance/cli branch June 16, 2024 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request test
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants