New cookiecutter #29

CodeWithEmad · 2023-12-26T11:59:33Z

This includes several improvements to the overall functionality of the cookiecutter:

Added Cookiecutter hooks that validate input data.
Expanded support for various licenses.
Implemented a new documentation format.
Added GitHub Actions for new plugins. Close Include basic CI setup for new plugins #7
Added a dev mode to extra entries.
Consolidated all configurations in one place for improved readability.

This is a result of a couple of sleepless nights. I wanted to explore all the features of the Cookiecutter package. Feel free to experiment and add more elements to it.

Close #7 #30

CodeWithEmad · 2024-01-29T05:55:18Z

I wanted to remind you that this PR has been open for over a month. Before merging it, I would appreciate a thorough review from anyone.
@kdmccormick
@regisb

kdmccormick · 2024-01-29T14:55:29Z

Sorry for the radio silence @CodeWithEmad . Reviewing this is in my backlog.

CodeWithEmad · 2024-01-31T06:19:11Z

No worries. Thanks in advance.

regisb

I expected this would be a big review... which is why I unconsciously postponed it as much as I could 😓 sorry about that!

Despite my many comments, I agree with the general direction, and I think it's going to be a great improvement. Thanks a lot Emad!

README.rst

{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/plugin.py

cookiecutter.json

hooks/pre_gen_project.py

{{ cookiecutter.package_name }}/setup.py

CodeWithEmad · 2024-02-11T12:31:55Z

Thanks for the review, @regisb, and sorry for the late response. I was on a vacation. Will look into the comments as soon as I get the chance.

CodeWithEmad · 2024-02-12T12:50:43Z

That took more than I expected.
Kindly have a look, @regisb.
Also, about pkg_resources issue on Python 3.12, what's the best approach? people can still select older tutor versions and I think we didn't backport those changes for older tutor versions.

regisb · 2024-02-13T08:16:20Z

This is how pkg_resources should be handled:
overhangio/tutor#977
overhangio/tutor-minio@3873ae0

regisb

This looks good to me, but I'd like to have someone else's opinion :) @kdmccormick?

We currently support 4 types of licenses: AGPLv3, Apache 2.0, BSDv3, and MIT. if the user selects "Not open source", then this file will be removed in the post_generate hook.

- overhang domain changed to edly. - cookiecutter document changed to main page - using code-blocks for better readability - followed the openedx doc conventions for rst files

with these we can sanitize our data before and modify files after cookiecutter was generated.

as of tutor >=17.0.0, there's no need to run `tutor config save` after enable/disable a plugin.

CodeWithEmad · 2024-02-19T06:49:01Z

I've included the pkg_resources deprecation fix in this MR
@kdmccormick

kdmccormick

🚀🚀🚀

kdmccormick · 2024-02-20T15:28:18Z

CHANGELOG.md

+- [Improvement] Happy New Year!
+    Fix compatibility issue with Python 3.12 by removing dependency on `pkg_resources`.
+    Cookiecutter hooks to check input data validation.
+    Various licenses support.
+    New documentation format.
+    GitHub Actions for new plugins.
+    `dev` mode added to extra entries.
+  (by @CodeWithEmad).


Suggested change

- [Improvement] Happy New Year!

Fix compatibility issue with Python 3.12 by removing dependency on `pkg_resources`.

Cookiecutter hooks to check input data validation.

Various licenses support.

New documentation format.

GitHub Actions for new plugins.

`dev` mode added to extra entries.

(by @CodeWithEmad).

- [Improvement] Happy New Year!

- Fix compatibility issue with Python 3.12 by removing dependency on `pkg_resources`.

- Cookiecutter hooks to check input data validation.

- Various licenses support.

- New documentation format.

- GitHub Actions for new plugins.

- `dev` mode added to extra entries.

(by @CodeWithEmad).

Without the bullet points, this will all render on one line.

Sharp eyes 👀
fixed.

- ignore all dirs starts with tutor-contrib- - __pycache__ added

The long_description_content_type parameter is added to the setup() function to explicitly specify that the long description content is in reStructuredText format.

pkg_resources is a package that is unavailable in python 3.12, unless setuptools is explicitely installed. Turns out, there are replacement functions coming from importlib_resources, which can be obtained from the importlib-resources pypi package. This package will be installed with tutor starting from 17.0.2.

CodeWithEmad · 2024-02-20T20:07:44Z

Should I consider closing #7 after this got merged?

kdmccormick · 2024-02-20T21:22:10Z

Indeed we should consider that closed. Thanks Emad!

CodeWithEmad · 2024-02-21T06:34:26Z

Awesome, so I merge this if there's nothing else to add. @DawoudSheraz

DawoudSheraz · 2024-02-21T09:12:44Z

Awesome, so I merge this if there's nothing else to add. @DawoudSheraz

Hi, I will add my review today. Sorry for the delay on my end.

CodeWithEmad · 2024-02-26T05:41:38Z

@DawoudSheraz just a friendly reminder. I don't wanna keep this PR open any longer.

regisb · 2024-02-27T06:59:20Z

Thanks again for your work Emad :)

CodeWithEmad · 2024-02-27T07:26:52Z

Anytime, @regisb.

CodeWithEmad requested review from regisb and kdmccormick December 26, 2023 11:59

regisb requested changes Feb 2, 2024

View reviewed changes

regisb assigned CodeWithEmad Feb 6, 2024

DawoudSheraz self-requested a review February 6, 2024 09:14

CodeWithEmad force-pushed the new-cookiecutter branch from 1d8e715 to 6cde338 Compare February 12, 2024 12:50

regisb approved these changes Feb 13, 2024

View reviewed changes

CodeWithEmad added 10 commits February 18, 2024 16:56

fix: use cookiecutter.version

20f38df

feat: LICENSE.txt added

700c5e5

We currently support 4 types of licenses: AGPLv3, Apache 2.0, BSDv3, and MIT. if the user selects "Not open source", then this file will be removed in the post_generate hook.

docs: cleanup

3c67afc

- overhang domain changed to edly. - cookiecutter document changed to main page - using code-blocks for better readability - followed the openedx doc conventions for rst files

fix: migration from v0 plugin moved to docs

70a662b

feat: new cookiecutter variables added

2875cfe

feat: human readable prompts added

86e653c

fix: tutor supports python >= 3.8

f567efd

feat: hooks added

8562272

with these we can sanitize our data before and modify files after cookiecutter was generated.

ci: tests added

fdd5566

fix: config save step removed

8af4973

as of tutor >=17.0.0, there's no need to run `tutor config save` after enable/disable a plugin.

CodeWithEmad force-pushed the new-cookiecutter branch from 6cde338 to 0d44dcc Compare February 18, 2024 13:31

kdmccormick approved these changes Feb 20, 2024

View reviewed changes

CodeWithEmad force-pushed the new-cookiecutter branch from 4f5458e to 17dab1d Compare February 20, 2024 20:03

CodeWithEmad added 3 commits February 20, 2024 23:35

fix: .gitignore updated

33bf556

- ignore all dirs starts with tutor-contrib- - __pycache__ added

fix: long_description_content_type added

d21cca7

The long_description_content_type parameter is added to the setup() function to explicitly specify that the long description content is in reStructuredText format.

chore: changelog added

ee8b205

CodeWithEmad force-pushed the new-cookiecutter branch from 17dab1d to bcfc62d Compare February 20, 2024 20:05

CodeWithEmad mentioned this pull request Feb 21, 2024

cookiecutter-tutor-plugin codebase Python 3.12 upgrade #30

Closed

DawoudSheraz approved these changes Feb 26, 2024

View reviewed changes

CodeWithEmad merged commit 5d5241d into overhangio:master Feb 26, 2024

CodeWithEmad deleted the new-cookiecutter branch February 27, 2024 07:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New cookiecutter #29

New cookiecutter #29

CodeWithEmad commented Dec 26, 2023 •

edited

Loading

CodeWithEmad commented Jan 29, 2024

kdmccormick commented Jan 29, 2024

CodeWithEmad commented Jan 31, 2024

regisb left a comment

CodeWithEmad commented Feb 11, 2024

CodeWithEmad commented Feb 12, 2024 •

edited

Loading

regisb commented Feb 13, 2024

regisb left a comment

CodeWithEmad commented Feb 19, 2024 •

edited

Loading

kdmccormick left a comment

kdmccormick Feb 20, 2024

CodeWithEmad Feb 20, 2024

CodeWithEmad commented Feb 20, 2024

kdmccormick commented Feb 20, 2024

CodeWithEmad commented Feb 21, 2024 •

edited

Loading

DawoudSheraz commented Feb 21, 2024

CodeWithEmad commented Feb 26, 2024

regisb commented Feb 27, 2024

CodeWithEmad commented Feb 27, 2024

New cookiecutter #29

New cookiecutter #29

Conversation

CodeWithEmad commented Dec 26, 2023 • edited Loading

CodeWithEmad commented Jan 29, 2024

kdmccormick commented Jan 29, 2024

CodeWithEmad commented Jan 31, 2024

regisb left a comment

Choose a reason for hiding this comment

CodeWithEmad commented Feb 11, 2024

CodeWithEmad commented Feb 12, 2024 • edited Loading

regisb commented Feb 13, 2024

regisb left a comment

Choose a reason for hiding this comment

CodeWithEmad commented Feb 19, 2024 • edited Loading

kdmccormick left a comment

Choose a reason for hiding this comment

kdmccormick Feb 20, 2024

Choose a reason for hiding this comment

CodeWithEmad Feb 20, 2024

Choose a reason for hiding this comment

CodeWithEmad commented Feb 20, 2024

kdmccormick commented Feb 20, 2024

CodeWithEmad commented Feb 21, 2024 • edited Loading

DawoudSheraz commented Feb 21, 2024

CodeWithEmad commented Feb 26, 2024

regisb commented Feb 27, 2024

CodeWithEmad commented Feb 27, 2024

CodeWithEmad commented Dec 26, 2023 •

edited

Loading

CodeWithEmad commented Feb 12, 2024 •

edited

Loading

CodeWithEmad commented Feb 19, 2024 •

edited

Loading

CodeWithEmad commented Feb 21, 2024 •

edited

Loading