Billingegroup / cookiecutter

A cookie-cutter for DiffPy packages.
Other
1 stars 8 forks source link

Replace functionality of setup.py with pyproject.toml #47

Closed 8bitsam closed 3 months ago

8bitsam commented 3 months ago

Closes #7 See git diff screenshot (--- is old, +++ is new): Screenshot from 2024-06-20 11-51-25

Sparks29032 commented 3 months ago

Can you change exclude to [ "{{ cookiecutter.project_name}}.tests*" ]. The include change is probably fine as we would likely need another post_gen hook to properly fix it up.

8bitsam commented 3 months ago

This is the latest git diff, for reference: Screenshot from 2024-06-21 12-13-30

sbillinge commented 3 months ago

This is the latest git diff, for reference: Screenshot from 2024-06-21 12-13-30

Thanks for this. Getting there. Questions:

  1. Do we want a keywords keyword? - [Simon] yes, maybe with a reasonable default. We need to understand what they are used for to make better keywords
  2. Homepage. Is it better with or without the trailing slash? Let's pick one and either change diffpy.utils or change the cookiecutter. Is there an industry standard on this?
  3. include. do we want the diffpy there? In that case we would have to have something like {{ cookiecutter.github_org }} or {{ cookiecutter.package_name }} or something.
8bitsam commented 3 months ago

@sbillinge To answer your questions: 1) I agree, I think the user could provide a number of keywords (maybe max 3 to keep it from being bloated) when they call cookiecutter. 2) No industry standard that I know of, but it's prob just easier to change it here since it doesn't really matter. 3) There's the case that some diffpy packages might not have a diffpy directory so I think we should keep it default. It shouldn't change anything afaik.

sbillinge commented 3 months ago

@sbillinge To answer your questions:

1. I agree, I think the user could provide a number of keywords (maybe max 3 to keep it from being bloated) when they call cookiecutter.

2. No industry standard that I know of, but it's prob just easier to change it here since it doesn't really matter.

3. There's the case that some diffpy packages might not have a diffpy directory so I think we should keep it default. It shouldn't change anything afaik.

sounds good.

  1. ok, please go ahead and implement that on a separate PR (make an issue first)
  2. @Sparks29032 I am not sure about this. We spent quite a lot of time making things run right, which is why we want things to conform to diffpy.utils, to leverage al that work. It is dangerous to assume things will work with releases.....
sbillinge commented 3 months ago

@8bitsam we need to remove the conflict.

8bitsam commented 3 months ago

@sbillinge Should be able to merge fine now.

Tieqiong commented 3 months ago

@8bitsam @sbillinge I think we need to change the cookiecutter.full_name into something else in pyproject.toml. I pulled this and can't cut anymore because of it.

Sparks29032 commented 3 months ago

@8bitsam @sbillinge I think we need to change the cookiecutter.full_name into something else in pyproject.toml. I pulled this and can't cut anymore because of it.

Yes, we definitely do. I already re-opened pyproject.toml to address this.