new-albums icon indicating copy to clipboard operation
new-albums copied to clipboard

Published 20 hours ago • verified publisher icon riverscuomo

Simplify the packaging configuration?

Open brettcannon opened this issue 2 years ago • 3 comments

I noticed you have a pyproject.toml file configured for Poetry on top of a setup.py. Thanks to the [build-system] section of your pyproject.toml, I believe the setup.py file might be unnecessary based on your pip workflow as it will use pyproject.toml for the same effect (which includes editable installs). So I don't quite see a direct benefit to having to maintain both a Setuptools configuration on top of the one you have for Poetry unless you're running really old versions of pip or you happen to have some other reason for wanting both. None of this specifically hurts/breaks anything.

I also noticed you have a requirements.txt file, but it isn't mentioned in your README.md in your development instruction section. Is that on purpose or would you like a PR to update the README for the pip install . line? And if you want a PR for that, would you also like it to suggest using something like pip-tools to help maintain your requirements.txt file so you don't have to do it by hand?

brettcannon avatar Nov 24 '22 05:11 brettcannon

Thanks. Yeah, all this poetry and packaging stuff is new to me so I probably have some obsolete files lying around. Feel free to clean things up and submit a PR.

riverscuomo avatar Nov 27 '22 03:11 riverscuomo

Do you mind if I ask some clarifying question to help scope how far and in what direction you might want me to go in a proposed cleanup?

  1. Do you want to stick with Poetry?
  2. Do you want to stick with pip?
  3. Do you want to keep both workflows (if you said "yes" to both the points above)?
  4. Do you view this more as an app or as a library?
  5. Do you want this to go up on PyPI?
  6. Do you want the project to be installable so someone can have a new-albums command on their machine)?

Please let me know if I'm taking this too far and you want me to keep the scope of this much smaller/simpler. 😅 The key thing is you have to be happy with the workflow at the end of the day, but I'm also willing to go as far as you want and you want (and explain myself along the way) to help you learn more about Python's packaging ecosystem (which I'm heavily involved with, so I can admittedly get excited about this more than the average person 😁).

brettcannon avatar Nov 28 '22 22:11 brettcannon

I opened discussions and answered over there https://github.com/riverscuomo/new-albums/discussions/29#discussion-4613740

riverscuomo avatar Nov 30 '22 03:11 riverscuomo