3 """Initialize a newly-created repository."""
6 from __future__ import print_function
11 FIXME: list authors' names and email addresses.
15 FIXME: describe how to cite this lesson.
18 ROOT_CONTRIBUTING_MD = '''\
21 [Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
22 and we welcome contributions of all kinds:
24 fixes to existing material,
26 and reviews of proposed changes are all welcome.
28 ## Contributor Agreement
31 you agree that we may redistribute your work under [our license](LICENSE.md).
33 we will address your issues and/or assess your change proposal as promptly as we can,
34 and help you become a member of our community.
35 Everyone involved in [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
36 agrees to abide by our [code of conduct](CONDUCT.md).
40 The easiest way to get started is to file an issue
41 to tell us about a spelling mistake,
44 This is a good way to introduce yourself
45 and to meet some of our community members.
47 1. If you do not have a [GitHub][github] account,
48 you can [send us comments by email][email].
50 we will be able to respond more quickly if you use one of the other methods described below.
52 2. If you have a [GitHub][github] account,
53 or are willing to [create one][github-join],
54 but do not know how to use Git,
55 you can report problems or suggest improvements by [creating an issue][issues].
56 This allows us to assign the item to someone
57 and to respond to it in a threaded discussion.
59 3. If you are comfortable with Git,
60 and would like to add or change material,
61 you can submit a pull request (PR).
62 Instructions for doing this are [included below](#using-github).
64 ## Where to Contribute
66 1. If you wish to change this lesson,
67 please work in <https://github.com/swcarpentry/FIXME>,
68 which can be viewed at <https://swcarpentry.github.io/FIXME>.
70 2. If you wish to change the example lesson,
71 please work in <https://github.com/swcarpentry/lesson-example>,
72 which documents the format of our lessons
73 and can be viewed at <https://swcarpentry.github.io/lesson-example>.
75 3. If you wish to change the template used for workshop websites,
76 please work in <https://github.com/swcarpentry/workshop-template>.
77 The home page of that repository explains how to set up workshop websites,
78 while the extra pages in <https://swcarpentry.github.io/workshop-template>
79 provide more background on our design choices.
81 4. If you wish to change CSS style files, tools,
82 or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
83 please work in <https://github.com/swcarpentry/styles>.
87 There are many ways to contribute,
88 from writing new exercises and improving existing ones
89 to updating or filling in the documentation
90 and and submitting [bug reports][issues]
91 about things that don't work, aren't clear, or are missing.
92 If you are looking for ideas,
93 please see [the list of issues for this repository][issues],
94 or the issues for [Data Carpentry][dc-issues]
95 and [Software Carpentry][swc-issues] projects.
97 Comments on issues and reviews of pull requests are just as welcome:
98 we are smarter together than we are on our own.
99 Reviews from novices and newcomers are particularly valuable:
100 it's easy for people who have been using these lessons for a while
101 to forget how impenetrable some of this material can be,
102 so fresh eyes are always welcome.
104 ## What *Not* to Contribute
106 Our lessons already contain more material than we can cover in a typical workshop,
107 so we are usually *not* looking for more concepts or tools to add to them.
109 if you want to introduce a new idea,
110 you must (a) estimate how long it will take to teach
111 and (b) explain what you would take out to make room for it.
112 The first encourages contributors to be honest about requirements;
113 the second, to think hard about priorities.
115 We are also not looking for exercises or other material that only run on one platform.
116 Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users;
117 in order to be usable,
118 our lessons must run equally well on all three.
122 If you choose to contribute via GitHub,
123 you may want to look at
124 [How to Contribute to an Open Source Project on GitHub][how-contribute].
127 1. The published copy of the lesson is in the `gh-pages` branch of the repository
128 (so that GitHub will regenerate it automatically).
129 Please create all branches from that,
130 and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
131 before starting work.
132 Please do *not* work directly in your `gh-pages` branch,
133 since that will make it difficult for you to work on other contributions.
135 2. We use [GitHub flow][github-flow] to manage changes:
136 1. Create a new branch in your desktop copy of this repository for each significant change.
137 2. Commit the change in that branch.
138 3. Push that branch to your fork of this repository on GitHub.
139 4. Submit a pull request from that branch to the [master repository][repo].
140 5. If you receive feedback,
141 make changes on your desktop and push to your branch on GitHub:
142 the pull request will update automatically.
144 Each lesson has two maintainers who review issues and pull requests
145 or encourage others to do so.
146 The maintainers are community volunteers,
147 and have final say over what gets merged into the lesson.
151 General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
152 happens on the [discussion mailing list][discuss-list],
153 which everyone is welcome to join.
154 You can also [reach us by email][email].
156 [email]: mailto:admin@software-carpentry.org
157 [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
158 [dc-lessons]: http://datacarpentry.org/lessons/
159 [dc-site]: http://datacarpentry.org/
160 [discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
161 [github]: http://github.com
162 [github-flow]: https://guides.github.com/introduction/flow/
163 [github-join]: https://github.com/join
164 [how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
165 [issues]: https://github.com/swcarpentry/FIXME/issues/
166 [repo]: https://github.com/swcarpentry/FIXME/
167 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
168 [swc-lessons]: http://software-carpentry.org/lessons/
169 [swc-site]: http://software-carpentry.org/
172 ROOT_CONFIG_YML = '''\
173 #------------------------------------------------------------
174 # Values for this lesson.
175 #------------------------------------------------------------
177 # Which carpentry is this ("swc", "dc", or "lc")?
180 # Overall title for pages.
181 title: "Lesson Title"
183 # Contact. This *must* include the protocol: if it's an email
184 # address, it must look like "mailto:lessons@software-carpentry.org",
185 # or if it's a URL, "https://gitter.im/username/ProjectName".
186 email: "mailto:lessons@software-carpentry.org"
188 #------------------------------------------------------------
189 # Generic settings (should not need to change).
190 #------------------------------------------------------------
192 # What kind of thing is this ("workshop" or "lesson")?
195 # Magic to make URLs resolve both locally and on GitHub.
196 # See https://help.github.com/articles/repository-metadata-on-github-pages/.
197 repository: <USERNAME>/<PROJECT>
200 amy_site: "https://amy.software-carpentry.org/workshops"
201 dc_site: "http://datacarpentry.org"
202 swc_github: "https://github.com/swcarpentry"
203 swc_site: "https://software-carpentry.org"
204 swc_pages: "https://swcarpentry.github.io"
205 lc_site: "http://librarycarpentry.github.io/"
206 template_repo: "https://github.com/swcarpentry/styles"
207 example_repo: "https://github.com/swcarpentry/lesson-example"
208 example_site: "https://swcarpentry.github.com/lesson-example"
209 workshop_repo: "https://github.com/swcarpentry/workshop-template"
210 workshop_site: "https://swcarpentry.github.io/workshop-template"
211 training_site: "https://swcarpentry.github.io/instructor-training"
214 pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="
215 post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_id="
216 training_post_survey: "https://www.surveymonkey.com/r/post-instructor-training"
218 # Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
221 # Specify that things in the episodes collection should be output.
225 permalink: /:path/index.html
228 permalink: /:path/index.html
230 # Set the default layout for things in the episodes collection.
240 # Files and directories that are not to be copied.
245 # Turn off built-in syntax highlighting.
253 permalink: index.html # Is the only page that don't follow the partner /:path/index.html
255 FIXME: home page introduction
263 ROOT_REFERENCE_MD = '''\
286 window.onload = function() {
287 var lesson_episodes = [
288 {% for episode in site.episodes %}
289 "{{ episode.url}}"{% unless forloop.last %},{% endunless %}
292 var xmlHttp = []; /* Required since we are going to query every episode. */
293 for (i=0; i < lesson_episodes.length; i++) {
294 xmlHttp[i] = new XMLHttpRequest();
295 xmlHttp[i].episode = lesson_episodes[i]; /* To enable use this later. */
296 xmlHttp[i].onreadystatechange = function() {
297 if (this.readyState == 4 && this.status == 200) {
298 var article_here = document.getElementById(this.episode);
299 var parser = new DOMParser();
300 var htmlDoc = parser.parseFromString(this.responseText,"text/html");
301 var htmlDocArticle = htmlDoc.getElementsByTagName("article")[0];
302 article_here.innerHTML = htmlDocArticle.innerHTML;
305 episode_url = "{{ page.root }}" + lesson_episodes[i];
306 xmlHttp[i].open("GET", episode_url);
307 xmlHttp[i].send(null);
312 Create anchor for each one of the episodes.
314 {% for episode in site.episodes %}
315 <article id="{{ episode.url }}"></article>
319 EPISODES_INTRODUCTION_MD = '''\
321 title: "Introduction"
333 EXTRAS_ABOUT_MD = '''\
338 {% include carpentries.html %}
341 EXTRAS_DISCUSS_MD = '''\
349 EXTRAS_FIGURES_MD = '''\
355 window.onload = function() {
356 var lesson_episodes = [
357 {% for episode in site.episodes %}
358 "{{ episode.url}}"{% unless forloop.last %},{% endunless %}
361 var xmlHttp = []; /* Required since we are going to query every episode. */
362 for (i=0; i < lesson_episodes.length; i++) {
363 xmlHttp[i] = new XMLHttpRequest();
364 xmlHttp[i].episode = lesson_episodes[i]; /* To enable use this later. */
365 xmlHttp[i].onreadystatechange = function() {
366 if (this.readyState == 4 && this.status == 200) {
367 var article_here = document.getElementById(this.episode);
368 var parser = new DOMParser();
369 var htmlDoc = parser.parseFromString(this.responseText,"text/html");
370 var htmlDocArticle = htmlDoc.getElementsByTagName("article")[0];
371 article_here.appendChild(htmlDocArticle.getElementsByTagName("h1")[0]);
372 for (let image of htmlDocArticle.getElementsByTagName("img")) {
373 article_here.appendChild(image);
377 episode_url = "{{ page.root }}" + lesson_episodes[i];
378 xmlHttp[i].open("GET", episode_url);
379 xmlHttp[i].send(null);
384 Create anchor for each one of the episodes.
386 {% for episode in site.episodes %}
387 <article id="{{ episode.url }}"></article>
391 EXTRAS_GUIDE_MD = '''\
394 title: "Instructor Notes"
400 ('AUTHORS', ROOT_AUTHORS),
401 ('CITATION', ROOT_CITATION),
402 ('CONTRIBUTING.md', ROOT_CONTRIBUTING_MD),
403 ('_config.yml', ROOT_CONFIG_YML),
404 ('index.md', ROOT_INDEX_MD),
405 ('reference.md', ROOT_REFERENCE_MD),
406 ('setup.md', ROOT_SETUP_MD),
407 ('aio.md', ROOT_AIO_MD),
408 ('_episodes/01-introduction.md', EPISODES_INTRODUCTION_MD),
409 ('_extras/about.md', EXTRAS_ABOUT_MD),
410 ('_extras/discuss.md', EXTRAS_DISCUSS_MD),
411 ('_extras/figures.md', EXTRAS_FIGURES_MD),
412 ('_extras/guide.md', EXTRAS_GUIDE_MD),
417 """Check for collisions, then create."""
421 for (path, _) in BOILERPLATE:
422 if os.path.exists(path):
423 print('Warning: {0} already exists.'.format(path), file=sys.stderr)
426 print('**Exiting without creating files.**', file=sys.stderr)
430 for (path, content) in BOILERPLATE:
431 with open(path, 'w') as writer:
432 writer.write(content)
435 if __name__ == '__main__':