search

Billingegroup / bg-mpl-stylesheets

Matplotlib style sheets
Other
4 stars 27 forks source link

Applying cookiecutter #41

Closed cadenmyers13 closed 1 month ago

cadenmyers13 commented 1 month ago

Messed up in editing the README.rst... working on fixing things

cadenmyers13 commented 1 month ago

looks good, thanks so much!

some things I see:

  1. delete LICENSE.txt (its replaced with the LICENSE.rst)
  2. please merge the old README.md into the README.rst and delete the old README.md
  3. check through the README for broken links and missing things
  4. I think the bg_mpl_stylesheet/__init__.py needs to be updated. We are not using hard-coded version numbers any more. It should have been replaced with a cookiecutter generated version.
  5. if possible, build the docs and see what they look like....
  6. delet requirements/README.txt when you have read and done everything
  7. delete setup.py
  8. fix init in src (see how it is handled in diffpy.pdfmorph for example)
  9. remove bg_mpl_stylesheet tree after checking it has all been moved to src/bg-mpl-stylesheet tree
  10. remove everything except bg-mpl-stylesheets and __init__.py from src

Make sure to test things after all this work. Make an env of a program that imports the stylesheet currently and verify it works (I think pdfmorph does?) then make a new env that installs the stylesheet from your new branch and make sure nothing breaks, something like that.

Are LICENSE.txt and README.md not removed in this? Same with setup.py. When i look in 'files changed' it looks likes they've been deleted.

cadenmyers13 commented 1 month ago

@sbillinge In the "Support and Contribute" section of the README, the cookiecutter put information about diffpy. Since this not a diffpy package I assume we don't want this. Is there something you'd like me replace this with?

cadenmyers13 commented 1 month ago

I made the init.py files dynamic by coping the format in src/bg-mpl-stylesheets/__init__.py.

cadenmyers13 commented 1 month ago

@sbillinge Okay, I made all the suggested edits. I ran pip install . and it install successfully. The only things I feel shaky on are the init.py files i edited in the above commits. Also, check the above comment i tagged you in regarding the README.rst. Let me know if anything else needs to be done!

sbillinge commented 1 month ago

Please don't force-push. I don't really want to merge anything with a force-push, it is too dangerous. Why are you force-pushing?

sbillinge commented 1 month ago

@cadenmyers13 this PR is getting a bit messy. I wonder if we should make use of what we learned in the process, and just start over.... I think it could go quickly and we would be more satisfied with the outcome. Perhaps we can do a PR that does the pre-commit things before the cookiecutter, following the new instructions?

cadenmyers13 commented 1 month ago

@cadenmyers13 this PR is getting a bit messy. I wonder if we should make use of what we learned in the process, and just start over.... I think it could go quickly and we would be more satisfied with the outcome. Perhaps we can do a PR that does the pre-commit things before the cookiecutter, following the new instructions?

I agree especially since I've done it once by myself. I will start fresh.