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 to make the package installable via PyPI #1

Merged
merged 1 commit into from Feb 3, 2021

Conversation

febrezo
Copy link
Contributor

@febrezo febrezo commented Feb 2, 2021

A small refactor has been performed to include the setup.py.
Dependencies are now managed by this file, as well as package
versioning and so on. Internal imports are now imported using
metafinder.utils.<whatever> syntax. For clarity, the launcher
(cli.py) has been separated from the processing(...) method.
This approach is closer to the use of the package as a library
making it closer to be imported as import metafinder.core.

Some minor issues have also been addressed:

  • The number of the results returned by Google was always 1 less
  • A new argument has been provided to set the output folder
  • The results folder is now created if it does not exist
  • pathlib package has been used for the creation of the folder
  • The usage execution has been clarified
  • Versioning has been started as 0.1.0. This may be changed.

Installation instructions in the README.md have been updated.
Note that these instructions won't be ready until the package
is uploaded to PyPI.

A small refactor has been performed to include the setup.py.
Dependencies are now managed by this file, as well as package
versioning and so on. Internal imports are now imported using
`metafinder.utils.<whatever>` syntax. For clarity, the launcher
(`cli.py`) has been separated from the `processing(...)` method.
This approach is closer to the use of the package as a library
making it closer to be imported as `import metafinder.core`.

Some minor issues have also been addressed:
- The number of the results returned by Google was always 1 less
- A new argument has been provided to set the output folder
- The `results` folder is now created if it does not exist
- `pathlib` package has been used for the creation of the folder
- The usage execution has been clarified
- Versioning has been started as `0.1.0`. This may be changed.

Installation instructions in the `README.md` have been updated.
 Note that these instructions won't be ready until the package
is uploaded to PyPI.
@Josue87 Josue87 merged commit 97aae3e into Josue87:main Feb 3, 2021
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.

None yet

2 participants