pyOpenSci / pyos-package-template

A Python package template that supports the pyOpenSci pure Python packaging tutorial
BSD 3-Clause "New" or "Revised" License
15 stars 11 forks source link

Review and test cookiecutter-pyopensci #7

Closed kysolvik closed 2 weeks ago

kysolvik commented 5 years ago

The basics of cookiecutter-pyopensci are all there and its ready to go! I tried to make the original cookiecutter-pypackage more beginner-friendly while avoiding any significant overhauls. It would be great if someone else could look it over and give it a try. Maybe @mbjoseph or @choldgraf, if either of you are up for it? Here's the tutorial.

It's currently set up with some example functions and tests, so that after downloading the cookiecutter repo, you can run some example tests. Then users can start adding their own code and tests. Any feedback is appreciated!

Summary of changes from cookiecutter-pypackage:

xmnlab commented 5 years ago

this template is very nice.

I think we should update some pinning. for example related to flake8 https://github.com/PyCQA/pycodestyle/issues/728

xmnlab commented 5 years ago

I can open an PR for that.

mbjoseph commented 5 years ago

Good point @xmnlab!

It would be nice to ensure that the deps don't need to be updated in the future. @lwasser or @kysolvik would it make sense to use PyUp to keep the dev requirements up to date? https://pyup.io/

xmnlab commented 5 years ago

would be good to promote here git pre-commit hooks? using for example black, isort, flake8, etc?

lwasser commented 2 weeks ago

Friends, I'm closing all of the open issues, given that we have a complete redo of the template now! 🚀! Thank you all for this discussion!! Please reopen this if I'm closing it in error.