neuroinformatics-unit / python-cookiecutter

Utility to create a basic Python project structure with tests, CI etc.
BSD 3-Clause "New" or "Revised" License
20 stars 3 forks source link

dependencies not in .toml file #24

Closed HernandoMV closed 1 year ago

HernandoMV commented 1 year ago

Project was created without dependencies line in .toml Maybe it would be unclear to people where to put them w/o an example. Add numpy maybe as default?

adamltyson commented 1 year ago

Good catch, thanks @HernandoMV!

@SainsburyWellcomeCentre/neuroinformatics-unit any thoughts here? It seems bad practice to have an empty dependencies section (and to add a potentially unused dependency). Should we just add a (fairly prominant) section to the readme showing people how to add dependencies to their project?

JoeZiminski commented 1 year ago

that is a nice idea to have an example section, although agree about empty and unused dependencies. Would it be possible to add a section to the cookiecutter CLI introduction - "would you like to add an example dependencies section to your pyproject.toml file?" or something similar

adamltyson commented 1 year ago

Would it be possible to add a section to the cookiecutter CLI introduction - "would you like to add an example dependencies section to your pyproject.toml file?" or something similar

I'm sure it is, not sure exactly how though.