search

pyOpenSci / cookiecutter-pyopensci

SOON TO BE DEPRECATED! Cookiecutter template for a pyOpenSci Python package.
https://cookiecutter-pyopensci.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
14 stars 7 forks source link

adopt a poetry based workflow, describe in tutorial & point to py-pkgs book? #25

Open NickleDave opened 3 years ago

NickleDave commented 3 years ago

Currently someone using our cookiecutter will declare dependencies that generate a requirements.txt -- I think this is handled by cookecutter itself on the command line?

Maybe we should consider alternatives, such as poetry or flit.

Not sure how they would integrate with cookiecutter though. Here's one attempt: https://github.com/johanvergeer/cookiecutter-poetry

If we do incorporate some external library for dev, probably a good idea to have some more detail on what it is and why to use it in the tutorial

Would be a very good reason to point to https://py-pkgs.org

NickleDave commented 3 years ago

@ttimbers points out on Twitter that the cookiecutter-ubc-mds in fact already incorporates poetry. https://twitter.com/TiffanyTimbers/status/1376569796574081025

Maybe we can borrow and/or integrate https://github.com/UBC-MDS/cookiecutter-ubc-mds

xmnlab commented 3 years ago

I think add options for other build system (not sure if it is correct name) would be great. maybe setuptools is not the best option, but at least it is still the most common, so maybe it should be the default option.

lwasser commented 3 years ago

maybe we have a separate conversation about tools and options. start by documenting in a hackmd file - get community input, assess each and go from there?

as i mentioned in the other issue, my concern is dependency mgt and installation / envt issues. also a good idea to figure out what most people are using now as ivan mentions! we use setuptools in all of our tools. this doesn't mean that it is the best option however!

shall i create a discussion forum here to discuss? or we could use discourse? boy we have a lot of decisions to make don't we?!!! :)

xmnlab commented 3 years ago

for me discussions here is easier :)

maybe we can create a post on discourse about the discussions here and send the link if anyone is interested in discussion :)

NickleDave commented 3 years ago

for me discussions here is easier :)

maybe we can create a post on discourse about the discussions here and send the link if anyone is interested in discussion :)

☝️ sounds like a good idea to me

I will post on discourse with a link to discussions if sb sets one up