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

Feature/migrate to poetry #24

Merged
merged 2 commits into from
May 8, 2024
Merged

Conversation

michael-bentz
Copy link
Contributor

@michael-bentz michael-bentz commented May 7, 2024

What does this change do?

This change migrates the project to use poetry for dependency management.

Why was this change made?

To align dependency management with other projects.

Verification

  1. Verify that all automated tests pass
  2. Update the report_handler dependency in PyCustodian
  • image
  1. Update dependencies with poetry install
  2. Run the sample script and verify that a xlsx report is generated that contains entries.

Affirmations

All of these should have a check by them. Any exception requires an explanation.

  • I have added docstrings with details on keyword arguments to new functions following the convention detailed in this gist
  • I have added type hinting to new function parameters.
  • I have added tests to new functions, following the rules of F.I.R.S.T..
  • I matched the style of the existing code.
  • I added and updated any relevant documentation (inline, README, CHANGELOG, and such).
  • I used Python's type hinting.
  • I ran the automated tests and ensured they ALL passed.
  • I ran the linter and ensured my changes have not introduced ANY warnings or errors.
  • I have made an effort to minimize code changes and have not included any cruft (preference files, *.pyc files, old comments, print-debugging, unused variables).
  • I have made an effort maintain a clear commit history (haven't merged other branches or rebased improperly).
  • I have written the code myself or have given credit where credit is due.

Copy link
Contributor

@sinarest1608 sinarest1608 left a comment

Choose a reason for hiding this comment

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

@mbentz-uf
All tests passed and a report was generated but not in the reports directory but in the root. Not sure if that is supposed to be.

@michael-bentz
Copy link
Contributor Author

@sinarest1608 Yes, if you debug the sample script you can see that this line creates the file at the current working directory:

https://github.com/ctsit/PyCustodian/blob/bbb6b89949e13e8bd452091ece154c2cb31ba153/py_custodian/scripts/sample_script.py#L21

@sinarest1608 sinarest1608 self-requested a review May 8, 2024 13:29
Copy link
Contributor

@sinarest1608 sinarest1608 left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@sinarest1608 sinarest1608 merged commit 6b064b1 into develop May 8, 2024
2 checks passed
@sinarest1608 sinarest1608 deleted the feature/migrate_to_poetry branch May 8, 2024 13:30
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.

2 participants