Using and Mastering Cookiecutter Transcripts
Chapter: Sharing your Cookiecutter template with the world
Lecture: Concept: Sharing steps
Login or purchase this course to watch this video and the rest of the course contents.
0:02 Let's review the steps that we went through to create our template, get it online, share it and submit it to the pantry.
0:11 So step one is having a template, period. So create some kind of template I recommend using the cookiecutter-template cookiecutter template
0:20 because that's the one that helps you get started here I've created one for Pyramid, we've already talked about it
0:25 and I want to share it, so I created the template, that was step one and this was quite a bit of work this is complicated, we have app
0:31 and it needs a lot of documentation, so I spent at least half a day working on this template, but you know it depends
0:37 on what kind of template or building, how much effort this step is. Next I put it on GitHub, so already I can use this in my documentation
0:45 I can use it in training videos or instructional videos say you want to get started with my version of a Pyramid web app
0:52 well you just cookiecutter space that URL and you're off to the races.
0:56 Having it somewhere online, GitHub is probably the best place, is the first step, right hopefully people come along, submit pull request to my template
1:05 make it even better; next we go to the official cookiecutter template that's github.com/audreyr/cookiecutter and we fork it.
1:13 So we fork this to our own repository so after we have it forked we check it out to edit it locally
1:20 I suppose if it's just restructured text if it's just those two lines you could technically do this online, but you probably want to have
1:26 a working copy locally anyway, so you do a git clone, notice this is my url, not theirs, that's very important
1:35 so we clone it, it comes down, we're ready to go now we can go and edit this folder right
1:40 basically that one file is surely all we got to edit in this case all right so like I said, make sure that that's your username not audreyr.
1:47 Next there's a whole bunch of files here this is the entire project that generates and runs Cookiecutter as well as its documentation
1:56 but the only one we care about is this README here so, because I'm working on a Python project I went to the Python section
2:03 and I'm going to add an entry here if I was working on assembly I would have gone to that section right, or if I was working on-
2:12 not sure or section that doesn't exist, but if there's a section that really makes sense for your type of work, and it doesn't exist
2:19 make anyone right, like Python online 2.99 and 300 do that for yours, so once we've edited it we've put our entry in there
2:25 we've checked it in, here we've committed our changes back to our repository we're going to want to create a pull request based on this
2:35 so we should have when we first do this a button right here that says create a new pull request, or just new pull request
2:43 I don't call it the exact verbiage but because I've already done it that button is gone, right, you saw me do that in the previous video
2:49 but you are going to have this ability to create a new pull request back to audreyr
2:53 and that's it, if you've done everything right, they like your addition they will accept it and you will be part of the pantry, congratulations.