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

Refactor scripts to put shared code in a shared library #92

Merged
merged 15 commits into from
Mar 27, 2024

Conversation

nox1134
Copy link
Contributor

@nox1134 nox1134 commented Mar 17, 2024

Fixes

Description

The shared code from various scripts has been moved to a shared library named quantify.py. This refactor eliminates duplicate code and improves code maintainability.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated 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

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

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.

Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
@nox1134 nox1134 requested review from a team as code owners March 17, 2024 10:27
@nox1134 nox1134 requested review from Shafiya-Heena and possumbilities and removed request for a team March 17, 2024 10:27
@IamMQaisar
Copy link
Contributor

This may cause relative import issue and also CWD / Root Diretories are not dealt in a right way.
have you tested it on the local machine and it works ?

@nox1134 nox1134 changed the title Refactor scripts to put shared code in a shared library [WIP] Refactor scripts to put shared code in a shared library Mar 17, 2024
@nox1134 nox1134 marked this pull request as draft March 17, 2024 11:13
@IamMQaisar
Copy link
Contributor

PATH_WORK_DIR is not being handled for CWD properly as in case of directory changing or renaming, due to being hard coded it will cause issues...Also at some places CWD is used rather than PATH_WORK_DIR

@IamMQaisar
Copy link
Contributor

IamMQaisar commented Mar 17, 2024

import quantify due to being shared through the root directory quantifying will have issues of relative/parent where PYTHONPATH is not handled.

Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
@nox1134 nox1134 marked this pull request as ready for review March 17, 2024 15:53
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
@nox1134 nox1134 changed the title [WIP] Refactor scripts to put shared code in a shared library Refactor scripts to put shared code in a shared library Mar 17, 2024
@nox1134
Copy link
Contributor Author

nox1134 commented Mar 17, 2024

Hi @IamMQaisar! The pull request was still in progress, so I marked it as a draft to indicate it was still being worked on. Now, the naming is consistent, and I've created a package for the shared code. To pass the current working directory's path, I'm now using __file__. Additionally, I've addressed the PYTHONPATH issues that were causing concerns.
Thank you!

@nox1134
Copy link
Contributor Author

nox1134 commented Mar 17, 2024

I've tested it locally, and everything appears to be functioning correctly. Could you please review it, @TimidRobot?

Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

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

this is looking great! please see requested changes

deviantart/deviantart_scratcher.py Outdated Show resolved Hide resolved
deviantart/deviantart_scratcher.py Outdated Show resolved Hide resolved
google_custom_search/google_scratcher.py Outdated Show resolved Hide resolved
google_custom_search/google_scratcher.py Outdated Show resolved Hide resolved
google_custom_search/google_scratcher.py Outdated Show resolved Hide resolved
vimeo/vimeo_scratcher.py Outdated Show resolved Hide resolved
wikicommons/wikicommons_scratcher.py Outdated Show resolved Hide resolved
wikipedia/wikipedia_scratcher.py Outdated Show resolved Hide resolved
youtube/youtube_scratcher.py Outdated Show resolved Hide resolved
youtube/youtube_scratcher.py Outdated Show resolved Hide resolved
nox1134 added 9 commits March 19, 2024 22:07
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
…join()

Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
@nox1134 nox1134 requested a review from TimidRobot March 19, 2024 17:26
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

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

just a few refinements left

vimeo/vimeo_scratcher.py Outdated Show resolved Hide resolved
wikicommons/wikicommons_scratcher.py Outdated Show resolved Hide resolved
quantify/quantify.py Outdated Show resolved Hide resolved
nox1134 added 2 commits March 20, 2024 23:14
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
@nox1134 nox1134 requested a review from TimidRobot March 20, 2024 18:06
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

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

When executed using pipenv it needs sys.path.append("."). With sys.path.append("..") it fails:

pipenv run google_custom_search/google_scratcher.py
Loading .env environment variables...
Traceback (most recent call last):
  File "[...]/quantifying/google_custom_search/google_scratcher.py", line 21, in <module>
    import quantify  # noqa: E402
    ^^^^^^^^^^^^^^^
ModuleNotFoundError: No module named 'quantify'

__init__.py Outdated Show resolved Hide resolved
Signed-off-by: Priyanshi Gaur <noxdot1134@gmail.com>
Copy link
Member

@TimidRobot TimidRobot left a comment

Choose a reason for hiding this comment

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

good work! thank you!

@TimidRobot TimidRobot merged commit acdf941 into creativecommons:main Mar 27, 2024
1 check passed
@TimidRobot TimidRobot self-assigned this Apr 2, 2024
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.

[Feature] refactor scripts to put shared code in a shared library
3 participants