Merlin icon indicating copy to clipboard operation
Merlin copied to clipboard

Create a template for new library creation that includes the common components required

Open EvenOldridge opened this issue 3 years ago • 4 comments

Checklist of things required:

  • [ ] Basic package structure
  • [ ] Test directory
  • [ ] Starter version of a Merlin requirements.txt and requirements-dev.txt
  • [ ] Versioneer
  • [x] Pre-commit hooks
  • [x] docstrings preview
  • [ ] Github Actions for testing
  • [ ] Jenkins/Blossom testing setup
  • [ ] Release tag auto-publishing
  • [x] LICENSE
  • [x] README
  • [ ] CONTRIBUTING
  • [ ] CLA
  • [ ] Release notes or changelog

Aha! Link: https://nvaiinfa.aha.io/features/MERLIN-811

EvenOldridge avatar Mar 09 '22 19:03 EvenOldridge

I think we could use either a Github repo template, or cookiecutter for this. Have used both, don't have a strong preference. Github repo template might be easier for people to use though.

karlhigley avatar Mar 15 '22 17:03 karlhigley

This is my personal Github repo template for Python packages: https://github.com/karlhigley/py-pkg-template

(Not saying we should use this, just sharing as an example of how they look)

karlhigley avatar Mar 15 '22 17:03 karlhigley

@karlhigley , @benfred , can we close this ticket?

viswa-nvidia avatar Aug 11 '22 00:08 viswa-nvidia

AFAIK, the template repo hasn't ever been completed, so if we intend to drop the work then we can close it, but otherwise it should stay open

karlhigley avatar Aug 11 '22 01:08 karlhigley