Switch PyProject to Poetry

[ppfeister]

Continuation of #2036

Package info

Sherlock Project added as Author
Homepage URL set to the github[.]io homepage (PyPi homepage already set, but not pip show)
Dynamic versioning fixed (pulled from sherlock[.]py)
Maintainers added
Classifiers added
Keywords added
Description added
etc

---

Refocused PR : PrProject being merged elsewhere to expedite package review process and resolve dependency issues (it takes time). This PR is now only to discuss switching to Poetry. (main pr #2116)

::: >>> Jump to start of refocused discussion <<< :::

[matheusfelipeog]

Just a comment to start a discussion:

I personally use the Poetry package manager instead of directly using pip for projects like this. It has a slightly different format from what setuptools accepts; you can view it here: https://python-poetry.org/docs/pyproject/

I find its dependency resolution mechanism better, with features that prevent the addition of dependencies that are not compatible with others in the project programmatically.

Since in the future we intend to add Sherlock to PyPI, Poetry can also help with that, as it has native build and publish mechanisms, eliminating the need to use other tools like twine.

For the average user, nothing would change; pip would work normally.
For development, well, it has all these features I mentioned above and a few more.

What do you think about this?

---

Refs:

• Python Packaging using Python-Poetry #1241
• https://python-poetry.org/
• https://python-poetry.org/docs/basic-usage/
• https://python-poetry.org/docs/pyproject/
• https://python-poetry.org/docs/cli/

[ppfeister]

Personally indifferent. No reservations or preference either way.
As long as normal pip usage isn't broken, then additional package manager support can only really be a plus.

As someone who hasn't used poetry, would this be as simple as making the pyproject compatible? Misread. It does in fact appear that simple.

[ppfeister]

So, I may be wrong on this, but it seems that poetry does not support dynamic versioning OOTB.

The package version will either have to be manually updated each time, or it would require an additional plugin that versions based on git tags (which sherlock doesn't currently use). Thoughts?

[ppfeister]

It also doesn't seem that poetry has support for dynamic loading of dependencies -- they would need to be explicitly listed in the pyproj. Thoughts there?

Seems finicky on my end. I'm able to install with poetry right now, but unable to uninstall it with poetry (need to use pip). I'm also unable to run sherlock via sherlock due to an odd import error, needing to run it with poetry run sherlock instead. I'm sure both problems can be solved, just haven't seen why yet.

Latest commit cb22902 is what I have for poetry.

[ppfeister]

Rebased onto master to fix conflict (some ~183 behind).

Poetry rewritten in a way that actually works.

Discovered that the current version of pyproject has some ~undesirable~ install issues, namely it doesn't install the src into a named directory and dumps them straight into site-packages for some unknown reason. Not only is this not pretty, it can cause some conflicts. This version fixes that behavior.

Due to how poetry handles packaging, the imports had to be rewritten.

Due to how the imports were rewritten, the (already poorly located) unit tests no longer function as desired.

Unit tests were relocated to the root where they probably should be anyways. Unit tests work from this location with modified imports.

**** PR action currently uses the old unit test location, so failure here is expected. ****

GitHub Actions for PRs will be fixed in another PR. I'll probably take advantage of that fixup to switch from the unittest module to tox, which is a bit more portable in my opinion.

This also removes the requirements.txt file, as dependencies should now be listed within the pyproj. If some sort of workflow requires the requirements.txt file, poetry itself can dump it from the pyproj.

Removed the setup.py and setup.cfg items as they are no longer necessary with the new layout.

Removed the rpm spec file.

Dynamic versioning still needs to be set up.

[ppfeister]

(a couple minor doc updates included, i.e. pyproj readme logo and capitalization)

[ppfeister]

Dynamic versioning added but not yet enabled. Relies on named tags and applies throughout Sherlock, rather than pulling from src.

[sdushantha]

LGMT

Proceeding with careful review to fix issues downstream