bin/lesson_initialize.py

   1 #!/usr/bin/env python
   2
   3 """Initialize a newly-created repository."""
   4
   5
   6 from __future__ import print_function
   7 import sys
   8 import os
   9
  10 ROOT_AUTHORS = '''\
  11 FIXME: list authors' names and email addresses.
  12 '''
  13
  14 ROOT_CITATION = '''\
  15 FIXME: describe how to cite this lesson.
  16 '''
  17
  18 ROOT_CONTRIBUTING_MD = '''\
  19 # Contributing
  20
  21 [Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
  22 and we welcome contributions of all kinds:
  23 new lessons,
  24 fixes to existing material,
  25 bug reports,
  26 and reviews of proposed changes are all welcome.
  27
  28 ## Contributor Agreement
  29
  30 By contributing,
  31 you agree that we may redistribute your work under [our license](LICENSE.md).
  32 In exchange,
  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).
  37
  38 ## How to Contribute
  39
  40 The easiest way to get started is to file an issue
  41 to tell us about a spelling mistake,
  42 some awkward wording,
  43 or a factual error.
  44 This is a good way to introduce yourself
  45 and to meet some of our community members.
  46
  47 1.  If you do not have a [GitHub][github] account,
  48     you can [send us comments by email][email].
  49     However,
  50     we will be able to respond more quickly if you use one of the other methods described below.
  51
  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.
  58
  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).
  63
  64 ## Where to Contribute
  65
  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>.
  69
  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>.
  74
  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.
  80
  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>.
  84
  85 ## What to Contribute
  86
  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, please see the 'Issues' tab for
  93 a list of issues associated with this repository,
  94 or you may also look at the issues for [Data Carpentry][dc-issues]
  95 and [Software Carpentry][swc-issues] projects.
  96
  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.
 103
 104 ## What *Not* to Contribute
 105
 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.
 108 As a rule,
 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.
 114
 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.
 119
 120 ## Using GitHub
 121
 122 If you choose to contribute via GitHub, you may want to look at
 123 [How to Contribute to an Open Source Project on GitHub][how-contribute].
 124 To manage changes, we follow [GitHub flow][github-flow].
 125 Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
 126 The maintainers are community volunteers and have final say over what gets merged into the lesson.
 127 To use the web interface for contributing to a lesson:
 128
 129 1.  Fork the master repository to your GitHub profile.
 130 2.  Within your version of the forked repository, move to the `gh-pages` branch and
 131 create a new branch for each significant change being made.
 132 3.  Navigate to the file(s) you wish to change within the new branches and make revisions as required.
 133 4.  Commit all changed files within the appropriate branches.
 134 5.  Create individual pull requests from each of your changed branches
 135 to the `gh-pages` branch within the master repository.
 136 6.  If you receive feedback, make changes using your issue-specific branches of the forked
 137 repository and the pull requests will update automatically.
 138 7.  Repeat as needed until all feedback has been addressed.
 139
 140 When starting work, please make sure your clone of the master `gh-pages` branch is up-to-date
 141 before creating your own revision-specific branch(es) from there.
 142 Additionally, please only work from your newly-created branch(es) and *not*
 143 your clone of the master `gh-pages` branch.
 144 Lastly, published copies of all the lessons are available in the `gh-pages` branch of the master
 145 repository for reference while revising.
 146
 147 ## Other Resources
 148
 149 General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
 150 happens on the [discussion mailing list][discuss-list],
 151 which everyone is welcome to join.
 152 You can also [reach us by email][email].
 153
 154 [email]: mailto:admin@software-carpentry.org
 155 [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
 156 [dc-lessons]: http://datacarpentry.org/lessons/
 157 [dc-site]: http://datacarpentry.org/
 158 [discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
 159 [github]: https://github.com
 160 [github-flow]: https://guides.github.com/introduction/flow/
 161 [github-join]: https://github.com/join
 162 [how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
 163 [issues]: https://guides.github.com/features/issues/
 164 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
 165 [swc-lessons]: https://software-carpentry.org/lessons/
 166 [swc-site]: https://software-carpentry.org/
 167 '''
 168
 169 ROOT_CONFIG_YML = '''\
 170 #------------------------------------------------------------
 171 # Values for this lesson.
 172 #------------------------------------------------------------
 173
 174 # Which carpentry is this ("swc", "dc", or "lc")?
 175 carpentry: "swc"
 176
 177 # Overall title for pages.
 178 title: "Lesson Title"
 179
 180 # Contact.  This *must* include the protocol: if it's an email
 181 # address, it must look like "mailto:lessons@software-carpentry.org",
 182 # or if it's a URL, "https://gitter.im/username/ProjectName".
 183 email: "mailto:lessons@software-carpentry.org"
 184
 185 #------------------------------------------------------------
 186 # Generic settings (should not need to change).
 187 #------------------------------------------------------------
 188
 189 # What kind of thing is this ("workshop" or "lesson")?
 190 kind: "lesson"
 191
 192 # Magic to make URLs resolve both locally and on GitHub.
 193 # See https://help.github.com/articles/repository-metadata-on-github-pages/.
 194 repository: <USERNAME>/<PROJECT>
 195
 196 # Sites.
 197 amy_site: "https://amy.software-carpentry.org/workshops"
 198 dc_site: "http://datacarpentry.org"
 199 swc_github: "https://github.com/swcarpentry"
 200 swc_site: "https://software-carpentry.org"
 201 swc_pages: "https://swcarpentry.github.io"
 202 lc_site: "https://librarycarpentry.github.io/"
 203 template_repo: "https://github.com/swcarpentry/styles"
 204 example_repo: "https://github.com/swcarpentry/lesson-example"
 205 example_site: "https://swcarpentry.github.com/lesson-example"
 206 workshop_repo: "https://github.com/swcarpentry/workshop-template"
 207 workshop_site: "https://swcarpentry.github.io/workshop-template"
 208 training_site: "https://swcarpentry.github.io/instructor-training"
 209
 210 # Surveys.
 211 pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="
 212 post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_id="
 213 training_post_survey: "https://www.surveymonkey.com/r/post-instructor-training"
 214
 215 # Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
 216 start_time: 0
 217
 218 # Specify that things in the episodes collection should be output.
 219 collections:
 220   episodes:
 221     output: true
 222     permalink: /:path/index.html
 223   extras:
 224     output: true
 225     permalink: /:path/index.html
 226
 227 # Set the default layout for things in the episodes collection.
 228 defaults:
 229   - values:
 230       root: ..
 231   - scope:
 232       path: ""
 233       type: episodes
 234     values:
 235       layout: episode
 236
 237 # Files and directories that are not to be copied.
 238 exclude:
 239   - Makefile
 240   - bin
 241
 242 # Turn on built-in syntax highlighting.
 243 highlighter: rouge
 244 '''
 245
 246 ROOT_INDEX_MD = '''\
 247 ---
 248 layout: lesson
 249 root: .
 250 permalink: index.html  # Is the only page that don't follow the partner /:path/index.html
 251 ---
 252 FIXME: home page introduction
 253
 254 > ## Prerequisites
 255 >
 256 > FIXME
 257 {: .prereq}
 258 '''
 259
 260 ROOT_REFERENCE_MD = '''\
 261 ---
 262 layout: reference
 263 root: .
 264 ---
 265
 266 ## Glossary
 267
 268 FIXME
 269 '''
 270
 271 ROOT_SETUP_MD = '''\
 272 ---
 273 layout: page
 274 title: Setup
 275 root: .
 276 ---
 277 FIXME
 278 '''
 279
 280 ROOT_AIO_MD = '''\
 281 ---
 282 layout: page
 283 root: .
 284 ---
 285 <script>
 286   window.onload = function() {
 287     var lesson_episodes = [
 288     {% for episode in site.episodes %}
 289     "{{ episode.url}}"{% unless forloop.last %},{% endunless %}
 290     {% endfor %}
 291     ];
 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;
 303         }
 304       }
 305       episode_url = "{{ page.root }}" + lesson_episodes[i];
 306       xmlHttp[i].open("GET", episode_url);
 307       xmlHttp[i].send(null);
 308     }
 309   }
 310 </script>
 311 {% comment %}
 312 Create anchor for each one of the episodes.
 313 {% endcomment %}
 314 {% for episode in site.episodes %}
 315 <article id="{{ episode.url }}"></article>
 316 {% endfor %}
 317 '''
 318
 319 EPISODES_INTRODUCTION_MD = '''\
 320 ---
 321 title: "Introduction"
 322 teaching: 0
 323 exercises: 0
 324 questions:
 325 - "Key question"
 326 objectives:
 327 - "First objective."
 328 keypoints:
 329 - "First key point."
 330 ---
 331 '''
 332
 333 EXTRAS_ABOUT_MD = '''\
 334 ---
 335 layout: page
 336 title: About
 337 ---
 338 {% include carpentries.html %}
 339 '''
 340
 341 EXTRAS_DISCUSS_MD = '''\
 342 ---
 343 layout: page
 344 title: Discussion
 345 ---
 346 FIXME
 347 '''
 348
 349 EXTRAS_FIGURES_MD = '''\
 350 ---
 351 layout: page
 352 title: Figures
 353 ---
 354 <script>
 355   window.onload = function() {
 356     var lesson_episodes = [
 357     {% for episode in site.episodes %}
 358     "{{ episode.url}}"{% unless forloop.last %},{% endunless %}
 359     {% endfor %}
 360     ];
 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);
 374           }
 375         }
 376       }
 377       episode_url = "{{ page.root }}" + lesson_episodes[i];
 378       xmlHttp[i].open("GET", episode_url);
 379       xmlHttp[i].send(null);
 380     }
 381   }
 382 </script>
 383 {% comment %}
 384 Create anchor for each one of the episodes.
 385 {% endcomment %}
 386 {% for episode in site.episodes %}
 387 <article id="{{ episode.url }}"></article>
 388 {% endfor %}
 389 '''
 390
 391 EXTRAS_GUIDE_MD = '''\
 392 ---
 393 layout: page
 394 title: "Instructor Notes"
 395 ---
 396 FIXME
 397 '''
 398
 399 BOILERPLATE = (
 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),
 413 )
 414
 415
 416 def main():
 417     """Check for collisions, then create."""
 418
 419     # Check.
 420     errors = False
 421     for (path, _) in BOILERPLATE:
 422         if os.path.exists(path):
 423             print('Warning: {0} already exists.'.format(path), file=sys.stderr)
 424             errors = True
 425     if errors:
 426         print('**Exiting without creating files.**', file=sys.stderr)
 427         sys.exit(1)
 428
 429     # Create.
 430     for (path, content) in BOILERPLATE:
 431         with open(path, 'w') as writer:
 432             writer.write(content)
 433
 434
 435 if __name__ == '__main__':
 436     main()