Closed nikochiko closed 2 years ago
Wouldn't it be better to use cookie-cutter for this?
You can look at an example at: https://github.com/pipalacademy/python-practice-problems/tree/main/cookiecutter-problem
It should:
* help the course developer to understand where each file goes, and how the settings need to be specified * give user a project template to fill in the blanks or swap out pieces
Shouldn't the goal just be:
Cookie cutter makes sense.
Shouldn't the goal just be:
create a new empty course with all required files from a predefined template
Yeah, okay 👍 . We don't need to make the template content serve as documentation.
Should we have cookiecutter
as a dependency and run it from python when riyaz new
is run, or let the user run cookiecutter
on their own?
It should:
Approach:
template/
folder insample-data/
that has files for chapters, lessons, authors, and course.ymlriyaz new {course-dir}
:{course-dir}
, copy contents oftemplate/
into{course-dir}/
. If directory exists, an error should be raised.{course-dir}/course.yml
into memory, change value ofcourse: {course-dir}
to the title-fied version of{course-dir}
.The sample data loaded should have some demonstration of how to use the features provided by riyaz.